| Info |
|---|
Beskrivelse af snitflade som Orkestreringskomponenten anvender og som udstilles af datakilder, der leverer data til digital digitale overblik gennem Orkestreringskomponenten. Redaktør: Kurt Hansen |
| Expand | ||
|---|---|---|
| ||
|
Introduktion
Snitfladebeskrivelser er opdelt i et dokument per datamodel. Hvis der er flere versioner af en snitflade for en datamodel, vil der være et dokument per version.
På siden vises kun beskrivelser af snitflader i den seneste version i produktion, da det er denne version, som nye datakilder skal anvende.
Snitfladebeskrivelser
...
Datamodel |
|---|
...
Snitfladedokumentation |
|---|
...
| Table of Contents |
|---|
1 Hentsagsliste
1.1 Introduktion
Servicen ”hentsagsliste” er en service som datakilder udstiller til orkestreringskomponenten, hvor orkestreringskomponenten, kan hente en liste over sager for en borger. Borgeren skal være identificeret med et CPR-nr, da dette er den primære nøgle ved hentning af sagsliste.
Servicen returnerer en liste over sager for borgeren.
Listen indeholder et begrænset antal attributter, der anvendes til at danne en overbliksliste over sager for borgeren.
1.2 Servicebeskrivelse
Servicenavn: /hentsagsliste
Beskrivelse: Servicen kaldes med et CPR-nr for den borger, der skal hentes sagsdata for. Servicen returnerer en liste af sager for borgeren. Den returnerede liste indeholder et begrænset antal attributter herunder status for sagen, og er designet til at understøtte visning af en overbliksliste over sager for den givne borger.
URL (REST): https://<datakilde.xxx>.dk/hentsagsliste/v2.0.0
Metode: servicen anvender http-verb: POST
Parametre:
...
Navn
...
Obligatorisk
...
Type
...
Beskrivelse
...
CPR-nr
...
Ja
...
String
...
Personnummer for bruger logget ind i visningsklient
...
kommunenr
...
Nej
...
String
...
Kommunenr for bopælskommune for borger angivet ved CPR-nr. Parameter skal anvendes af KOMBIT for at fremsøge data.
...
myndighedsliste
...
Ja
...
Liste af myndighedskoder
...
Liste af myndighedskoder som der er gyldige databehandleraftaler med og som datakilden leverer overbliksdata for
Response:
...
http-response
...
Beskrivelse
...
200 (OK)
...
Kald til service er succesfuld og fremfundne sagsliste-data returneres.
...
400 (bad request)
...
Fejl i Orkestreringskomponent i kald til service
...
401 (Unauthorized)
...
Orkestreringskomponent er ikke autoriseret til at kalde service
...
500 (Internal Server Error)
...
Fejl internt i datakilde
Data-svar (her angivet i JSON):
{
“sagslistedata” : {
”type” : “array”,
“items” : {
“type” : “BorgervendtSagListe”
}
}
}
”BorgervendtSagListe” er specificeret i skemafilen: Borgervendtsag Udvekslingsskemaer
2 Hentsagsdetaljer
2.1 Introduktion
Servicen ”hentsagsdetaljer” er en service som datakilder udstiller til orkestreringskomponenten, hvor orkestreringskomponenten kan hente detaljerede informationer for de sager en borger har. Borgeren skal være identificeret med et CPR-nr, da dette er den primære nøgle ved hentning af sagsdetaljer.
Servicen returnerer sagsdetaljer, for den specifikke sag der er angivet i kaldet.
2.2 Servicebeskrivelse
Servicenavn: /hentsagsdetaljer
Beskrivelse: Servicen kaldes med et CPR-nr for den borger, der skal hentes sagsdetaljer for. Der skal specifikt angives en sag, der ønskes sagsdetaljer for.
Hvis det angivne ”sagsID” ikke er for en sag for den angivne borger, returnerer servicen et tomt svar.
URL: https: ://<datakilde.xxx>.dk/hentsagsdetaljer/v2.0.0
Metode: servicen anvender http-verb: POST
Parametre:
...
Navn
...
Obligatorisk
...
Type
...
Beskrivelse
...
CPR-nr
...
Ja
...
String
...
Personnummer for bruger logget ind i visningsklient
...
myndighed
...
Ja
...
myndighedsKode
...
Myndighedskode for den myndighed der har sagen. Anvendes af domæneindeks til at afgøre hvor data for sag skal fremsøges.
...
sagsID
...
Ja
...
Sagsnummer
...
Nøgle for sag der skal hentes detaljer for.
Response:
...
http-response
...
Beskrivelse
...
200 (OK)
...
Kald til service er succesfuld og fremfundne sagsdetalje-data returneres.
...
400 (bad request)
...
Fejl i kald til service
...
401 (Unauthorized)
...
Orkestreringskomponent er ikke autoriseret til at kalde service
...
500 (Internal Server Error)
...
Fejl internt i datakilde
Data-svar (her angivet i JSON):
{
“sagsdetaljedata” : {
“type” : “BorgervendtSag”
}
}
”BorgervendtSag” er specificeret i skemafilen: Borgervendtsag-xsd. Udvekslingsskemaer
3 Hentbevillingsliste
3.1 Introduktion
Servicen ”hentbevillingsliste” er en service som datakilder udstiller til orkestreringskomponenten, hvor orkestreringskomponenten kan hente en liste over ydelser som en borger modtager eller har modtaget. Borgeren skal være identificeret med et CPR-nr, da dette er den primære nøgle ved hentning af bevillingsliste.
Servicen returnerer en liste over ydelser for borgeren. Listen indeholder et begrænset antal attributter, der anvendes til at danne en overbliksliste over ydelser for borgeren.
3.2 Servicebeskrivelse
Servicenavn: /hentbevillingsliste
Beskrivelse: Servicen kaldes med et CPR-nr for den borger, der skal hentes ydelser for. Servicen returnerer en liste af ydelser for borgeren. Den returnerede liste indeholder et begrænset antal attributter, og er designet til at understøtte visning af en overbliksliste over ydelser for den givne borger.
URL (REST): https://<datakilde.xxx>.dk/hentbevillingsliste/v2.1.0
Metode: servicen anvender http-verb: POST
Parametre:
...
Navn
...
Obligatorisk
...
Type
...
Beskrivelse
...
CPR-nr
...
Ja
...
String
...
Personnummer for bruger logget ind i visningsklient
...
kommunenr
...
Nej
...
String
...
Kommunenr for bopælskommune for borger angivet cved CPR-nr. Parameter skal anvendes af KOMBIT for at fremsøge data.
...
myndighedsliste
...
Ja
...
Liste af myndighedskoder
...
Liste af myndighedskoder som der er gyldige databehandleraftaler med og som datakilden leverer overbliksdata for
Response:
...
http-response
...
Beskrivelse
...
200 (OK)
...
Kald til service er succesfuld og fremfundne sagsliste-data returneres.
...
400 (bad request)
...
Fejl i Orkestreringskomponent i kald til service
...
401 (Unauthorized)
...
Orkestreringskomponent er ikke autoriseret til at kalde service
...
500 (Internal Server Error)
...
Fejl internt i datakilde
Data-svar (her angivet i JSON)::
{
“bevillingslistedata” : {
”type” : “array”,
“items” : {
“type” : “BorgerventBevillingsListe”
}
}
}
”BorgervendtBevillingsListe” er specificeret i skemafilen: BorgervendtYdelse-xsd.xsd
4 Hentbevillingsdetaljer
4.1 Introduktion
Servicen ”hentbevillingsdetaljer” er en service som datakilder udstiller til orkestreringskomponenten, hvor orkestreringskomponenten kan hente detaljerede informationer for de ydelser en borger modtager. Borgeren skal være identificeret med et CPR-nr, da dette er den primære nøgle ved hentning af detaljer om ydelser.
Servicen returnerer detaljer for den specifikke ydelse der er angivet i kaldet.
4.2 Servicebeskrivelse
Servicenavn: /hentbevillingsdetaljer
Beskrivelse: Servicen kaldes med et CPR-nr for den borger, der skal hentes ydelsedetaljer for. Der skal specifikt angives en ydelse som der ønskes detaljer for.
Der kan kun hentes ydelsesdetaljer for en udvalgt ydelse angivet ”ID” som input parameter i kaldet til servicen.
Hvis det angivne ”ID” ikke er for en ydelse for den angivne borger, returnerer servicen et tom svar.
URL (REST): https://<datakilde.xxx>.dk/ hentbevillingsdetaljer/v2.1.0
Metode: servicen anvender http-verb: POST
Format: Service understøtter både JSON og XM
Parametre:
...
Navn
...
Obligatorisk
...
Type
...
Beskrivelse
...
CPR-nr
...
Ja
...
String
...
Personnummer for bruger logget ind i visningsklient
...
myndighedskode
...
Ja
...
myndighedsKode
...
Myndighedskode for den myndighed der har sagen. Anvendes af domæneindeks til at afgøre hvor data for ydelse skal fremsøges.
...
ydelseID
...
Ja
...
ID
...
Nøgle for enydelse der skal hentes detaljer for.
Response:
...
http-response
...
Beskrivelse
...
200 (OK)
...
Kald til service er succesfuld og fremfundne ydelsesdetalje-data returneres.
...
400 (bad request)
...
Fejl i kald til service
...
401 (Unauthorized)
...
Orkestreringskomponent er ikke autoriseret til at kalde service
...
500 (Internal Server Error)
...
Fejl internt i datakilde
Data-svar (her angivet i JSON):
{
“borgervendtbevillingdata” : {
“type” : “BorgervendtBevilling”
}
}
”BorgervendtBevilling” er specificeret i skemafilen: BorgervendtYdelse-xsd.
5 Sikkerhed
Der anvendes best practices for identifikation af og validering af akkreditiv ved kald til webservices, gennem sikring af identiteten af både den kaldende og udstillende part vha. FOCES certifikater (Two way TLS).
Korreleringsnøgle til logning placeres et passende sted i http-header for REST-services og inkluderes i SOAP-body ved SOAP-services. Afklares senere.
...
Schema for kaldemodel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Borgervendt Sag v2.0.1 |
|
| ||||||||
Borgervendt Økonomisk ydelse v1.0.0 |
|
| ||||||||
Borgervendt Ydelse v2.1.0 (Serviceydelser og hjælpemidler) |
|
| ||||||||
Borgervendt Aftaler og frister v1.0.1 |
|
| ||||||||
Borgervendt Gæld og betalinger v1.0.0 |
|
| ||||||||
Borgervendt Akkreditiv v1.0.1 (Beviser, attester og tilladelser) |
|
| ||||||||
Borgervendt Akkreditiv v1.1.0 (Beviser, attester og tilladelser) |
|
| ||||||||
Borgervendt Stamdata v.1.0.0 |
|
|
Fejlhåndtering
Fejl der optræder på snitflader mod datakilder, håndteres af Orkestreringskomponenten, men rapporteres videre til visningsklienter i data-strukturen der returneres til visningsklienten.
Følgende fejltyper kan returneres:
Type | Title | Status |
Agreement-error | Internal error in OK during agreement control | 500 |
Data-source-error | Error calling data source | Get from Data source response status |
Data-source-timeout-error | Timeout reached for data source | 408 |
Data-source-internal-error | Internal error at data source | 500 |
Data-source-security-error | Security validation error when calling data source | 400 |
Data-source-format-error | Invalid format in response from data source | 422 |
Input-param-error | Invalid input parameter from display client | 400 |
Circuit-breaker-error | Circuit breaker is currently active for data source | 502 |
Data-validation-error | Validation error of data in response from data source | 400 |
Fejl returneres i en fejlstruktur der følger RFC 7807.
| Expand | ||
|---|---|---|
| ||
|