| Info | ||||||
|---|---|---|---|---|---|---|
Redaktør: Kurt Hansen |
...
Navn | Obligatorisk | Type | Beskrivelse | ||||
CPR-nr | Ja | String | Personnummer for bruger logget ind i visningsklient | ||||
visningsklientID | Ja | String | ID for visningsklient, således at dette kan medsendes ved kald til datakilder fra OK, til brug for udvælgelse af data og aftalestyring. | ||||
sagsID | ja | Sagsnummer | Nøgle for sag der skal hentes detaljer for. | ||||
datakilde | Ja | Datakilde-struktur | Visningsklient skal medsende datakilde-struktur for den udvalgte sag, som blev modtaget fra kald til overbliksliste. Der skal ikke ændres i indholdet af strukturen. Datakilde er specificeret i BorgervendtSag-xsd.xsd | ||||
myndighedskode | Ja | string | Visningsklient skal medsende myndighedsKode for den udvalgte sag, som blev modtaget fra kald til overbliksliste. MyndighedsKode skal hentes fra entiteten Myndighed relateret til den udvalgte sag. |
|
|
|
Denne parameter udgår. |
Response:
http-response | Beskrivelse |
200 (OK)
| Kald til service er succesfuld og fremfundne sagsdetalje-data returneres. |
400 (bad request) | Fejl i visningsklient i kald til service |
401 (Unauthorized) | Visningsklient er ikke autoriseret til at kalde service |
500 (Internal Server Error) | Fejl internt i orkestreringskomponenten |
...
Ingen fejlstruktur for detalje.
...
3 Hentbevillingsliste
3.1 Introduktion
Servicen ”hentoekonomiskydelsesliste” ”hentbevillingsliste” er en service som orkestreringskomponenten udstiller til visningsklienter, hvor visningsklienten, fx borger.dk, kan hente en liste over økonomiske 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 økonomiskydelseslistebevillingsliste.
Servicen returnerer en liste over økonomiske ydelser for borgeren, fra de datakilder der er tilsluttet Orkestreringskomponenten. Listen indeholder et begrænset antal attributter, der anvendes til at danne en overbliksliste over økonomiske ydelser for borgeren.
3.2 Servicebeskrivelse
Servicenavn: /hentoekonomiskydelseslistehentbevillingsliste
Beskrivelse: Servicen kaldes med et CPR-nr for den borger, der skal hentes økonomiske ydelser for. Servicen returnerer en liste af økonomiske ydelser for borgeren. Den returnerede liste indeholder et begrænset antal attributter, og er designet til at understøtte visning af en overbliksliste over økonomiske ydelser for den givne borger.
URL: https://orkestreringskomponenten.dk/hentoekonomiskydelselistehentbevillingsliste/v0v2.90.10
Metode: servicen anvender http-verb: POST
...
Navn | Obligatorisk | Type | Beskrivelse | ||||
CPR-nr | Ja | String | Personnummer for bruger logget ind i visningsklient | ||||
kommunenr | Ja | String | Kommunenr for bopælskommune for borger angivet ved CPR-nr. Parameter skal anvendes af KOMBIT for at fremsøge data. | ||||
visningsklientID | Ja | String | ID for visningsklient, således at dette kan anvendes til brug for udvælgelse af datakilder og aftalestyring. |
|
|
|
Denne parameter udgår |
Response:
http-response | Beskrivelse |
200 (Ok)
| Kald til service er succesfuld og fremfundne oekonomiskydelselistebevillingsliste-data returneres. |
400 (bad request) | Fejl i visningsklient i kald til service |
401 (Unauthorized) | Visningsklient er ikke autoriseret til at kalde service |
500 (Internal Server Error) | Fejl internt i orkestreringskomponenten |
...
Data-svar (her angivet i JSON):
{
“oekonomiskydelselistedata” “bevillingsdata” : {
”type” : “array”,
“items” : {
“type” : “BorgervendtOekonomiskYdelsesListe”“BorgervendtBevillingsListe”
}
}
}
”BorgervendtOekonomiskYdelsesListe” ”BorgervendtBevillingsListe” er specificeret i skemafilen: BorgervendtYdelse. Udvekslingsskemaer
...
Hvis der er fejl for flere datakilder, vil der være en fejlstruktur pr. datakilde.
...
4 Hentbevillingsdetaljer
4.1 Introduktion
Servicen ”hentoekonomiskydelsedetaljer” ”hentbevillingsdetaljer” er en service som orkestreringskomponenten udstiller til visningsklienter, hvor visningsklienten, fx borger.dk, kan hente detaljerede informationer for de økonomiske 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 økonomiske ydelser.
Servicen returnerer detaljer for den specifikke økonomiske ydelse der er angivet i kaldet, fra den datakilde der er tilsluttet Orkestreringskomponenten.
4.2 Servicebeskrivelse
Servicenavn: /hentoekonomiskydelsedetaljerhentbevillingsdetaljer
Beskrivelse: Servicen kaldes med et CPR-nr for den borger, der skal hentes økonomisk ydelsedetaljer for. Der skal specifikt angives en økonomisk ydelse som der ønskes detaljer for.
Der kan kun hentes økonomiske ydelsesdetaljer for en udvalgt økonomisk ydelse angivet ”ID” som input parameter i kaldet til servicen.
Hvis det angivne ”ID” ikke er for økonomiske ydelser for den angivne borger, returnerer servicen et tomt svar.
URL: https://orkestreringskomponenten.dk/hentoekonomiskydelsedetaljerhentbevillingsdetaljer/v0.9.1
Metode: servicen anvender http-verb: POST
...
Navn | Obligatorisk | Type | Beskrivelse | ||||
CPR-nr | Ja | String | Personnummer for bruger logget ind i visningsklient | ||||
visningsklientID | Ja | String | ID for visningsklient, således at dette kan medsendes til ved kald til datakilder fra OK, til brug for udvælgelse af data og aftalestyring. | ||||
ydelseID | Ja | String | Nøgle for den økonomiske ydelse der skal hentes detaljer for. | ||||
myndighedskode | Ja | string | Visningsklient skal medsende myndighedsKode for den udvalgte økonomiske ydelse, som blev modtaget fra kald til overbliksliste. MyndighedsKode skal hentes fra entiteten Myndighed relateret til den udvalgte økonomiske ydelse. | ||||
datakilde | Ja | Datakilde-struktur | Visningsklient skal medsende datakilde-struktur for den udvalgte ydelse, som blev modtaget fra kald til overbliksliste. Datakilde er specificeret i BorgervendtYdelse-xsd.xsd |
|
|
|
Denne parameter udgår. |
Response:
http-response | Beskrivelse |
200 (OK)
| Kald til service er succesfuld og fremfundne økonomisk ydelsesdetalje-data returneres. |
400 (bad request) | Fejl i visningsklient i kald til service |
401 (Unauthorized) | Visningsklient er ikke autoriseret til at kalde service |
500 (Internal Server Error) | Fejl internt i orkestreringskomponenten |
...