VisiteringOgStatus.YdelsesVisiteringService (Version 1, 2025-1)
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateYdelse (POST /v1/ydelse)
Opretter eller opdaterer en social ydelse for en borger så korrekt kontaktgruppe og personkategori sÊttes i DFDG.
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
JobCenter | Â | Â | Â | Â | X | Â | Â | Â |
Kommune | X | Â | Â | Â | Â | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.ydelse.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string |  | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max lÊngde for id'et er 46 chars |
requestBody | SaveYdelseRequestDto | Â | 1 | Requesttype |
-    kyYdelsesIdentifier | uuid |  | 1 | Unik nÞgle på ydelsessagen i KY |
-    startdato | date |  | 1 | Startdato på ydelsesperioden. Hvis hÊndelsen er "Ydelsessag startet" så den forventet startdato. |
-    slutdato | date |  | 0 - 1 | Slutdato på på ydelsesperioden. |
-Â Â Â Â kontaktgruppe | Â | 0 - 1 | Â | |
-    kyNoegle | string | Length: 1-100 | 0 - 1 | KYâs egen Brugervendt nÞgle pÃ¥ begreb. Denne mappes til satsniveauType i DFDG |
-    lovhenvisning | string | Length: 1-50 | 0 - 1 | §-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansÞgninger om kontanthjÊlpsydelser. Ikke udfyldt ved âYdelsessag startetâ og âYdelsessag afsluttetâ. Angives ved alle andre statusser. |
-Â Â Â Â ydelsesAfgoerelsesType | Â | 0 - 1 | Â |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
4669 | Slutdatoen må ikke ligge fÞr startdatoen | Slutdatoen må ikke ligge fÞr startdatoen |
9393 | Slutdato for ydelsen er obligatorisk når ydelsen afsluttes | Slutdato for ydelsen er obligatorisk når ydelsen afsluttes |
100049 | Lovhenvisning skal vÊre angivet ved afgÞrelser om KTH (kontaktgruppe 2) med startdato 1.7.2025 eller senere | Lovhenvisning skal vÊre angivet ved afgÞrelser om KTH (kontaktgruppe 2) med startdato 1.7.2025 eller senere |
100050 | KY nÞgle skal vÊre angivet ved afgÞrelser om KTH (kontaktgruppe 2) med startdato 1.7.2025 eller senere | KY nÞgle skal vÊre angivet ved afgÞrelser om KTH (kontaktgruppe 2) med startdato 1.7.2025 eller senere |
100051 | Den angivne identifier tilhÞrer ikke den specifikke person | Den angivne identifier tilhÞrer ikke den specifikke person |
100052 | Denne type af ydelse er ikke lovlig | Denne type af ydelse er ikke lovlig |
GetYdelser (GET /v1/ydelse)
Henter informationer om en borgers sociale ydelser.
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
JobCenter | Â | X | Â | X | X | X | Â | Â |
Kommune | Â | X | Â | Â | Â | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.ydelse.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetYdelserResponseDto | Â | 1 | Returtype |
-Â Â Â Â ydelser | YdelseDtoCollection | Â | 1 | Borgeres ydelsesperioder fra ydelsessystem. |
-Â Â Â Â -Â Â Â Â YdelseDto | YdelseDto | Â | 0 - * | Â |
-    -    -    kyYdelsesIdentifier | uuid |  | 1 | Unik nÞgle på ydelsessagen i KY |
-    -    -    startdato | date |  | 1 | Startdato på ydelsesperioden. Hvis hÊndelsen er "Ydelsessag startet" så den forventet startdato. |
-    -    -    slutdato | date |  | 0 - 1 | Slutdato på på ydelsesperioden. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â kontaktgruppe | Â | 0 - 1 | Â | |
-    -    -    kyNoegle | string | Length: 1-100 | 0 - 1 | KYâs egen Brugervendt nÞgle pÃ¥ begreb. Denne mappes til satsniveauType i DFDG |
-    -    -    lovhenvisning | string | Length: 1-50 | 0 - 1 | §-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansÞgninger om kontanthjÊlpsydelser. Ikke udfyldt ved âYdelsessag startetâ og âYdelsessag afsluttetâ. Angives ved alle andre statusser. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â ydelsesAfgoerelsesType | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â satsniveau | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â registrendeMyndighed | RegistrendeMyndighedDto | Â | 0 - 1 | Registrerende myndighed |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â myndighedskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â dfdgRegistreringsTidspunkt | date-time | Â | 0 - 1 | Registreringstidspunkt i DFDG |
Fejlkoder
Ingen fejlkoder
GetYdelse (GET /v1/ydelse/{ydelsesidentifier})
Henter informationer om en borgers sociale ydelser.
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
JobCenter | Â | X | Â | X | X | X | Â | Â |
Kommune | Â | X | Â | Â | Â | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.ydelse.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
ydelsesidentifier [Path] | uuid | Â | 1 | Â |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetYdelseResponseDto | Â | 1 | Returtype |
-Â Â Â Â ydelse | YdelseDto | Â | 1 | Kommunal ydelse |
-    -    kyYdelsesIdentifier | uuid |  | 1 | Unik nÞgle på ydelsessagen i KY |
-    -    startdato | date |  | 1 | Startdato på ydelsesperioden. Hvis hÊndelsen er "Ydelsessag startet" så den forventet startdato. |
-    -    slutdato | date |  | 0 - 1 | Slutdato på på ydelsesperioden. |
-Â Â Â Â -Â Â Â Â kontaktgruppe | Â | 0 - 1 | Â | |
-    -    kyNoegle | string | Length: 1-100 | 0 - 1 | KYâs egen Brugervendt nÞgle pÃ¥ begreb. Denne mappes til satsniveauType i DFDG |
-    -    lovhenvisning | string | Length: 1-50 | 0 - 1 | §-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansÞgninger om kontanthjÊlpsydelser. Ikke udfyldt ved âYdelsessag startetâ og âYdelsessag afsluttetâ. Angives ved alle andre statusser. |
-Â Â Â Â -Â Â Â Â ydelsesAfgoerelsesType | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â satsniveau | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â registrendeMyndighed | RegistrendeMyndighedDto | Â | 0 - 1 | Registrerende myndighed |
-Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â myndighedskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed. |
-Â Â Â Â -Â Â Â Â dfdgRegistreringsTidspunkt | date-time | Â | 0 - 1 | Registreringstidspunkt i DFDG |
Fejlkoder
Ingen fejlkoder
GetYdelseHistorik (GET /v1/ydelse/historik)
Henter historiske sociale ydelse for en borger.
Tilladte organisationer
 | Alle borgere | Egne borgere | Tidligere egne borgere | GÊsteadgang | Anden AktÞr - egne borgere | Anden AktÞr - gÊsteadgang | Anden AktÞr - alle borgere | System - alle borgere |
---|---|---|---|---|---|---|---|---|
JobCenter | Â | X | Â | X | X | X | Â | Â |
Kommune | Â | X | Â | Â | Â | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.ydelse.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilregistrationIdentifier [Header] | string | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetYdelseshistorikResponseDto | Â | 1 | Returtype |
-Â Â Â Â ydelser | YdelseHistorikCollection | Â | 1 | Borgeres ydelsesperioder fra ydelsessystem. |
-Â Â Â Â -Â Â Â Â YdelseHistorik | YdelseHistorik | Â | 0 - * | Â |
-    -    -    kyYdelsesIdentifier | uuid |  | 1 | Unik nÞgle på ydelsessagen i KY |
-    -    -    startdato | date |  | 1 | Startdato på ydelsesperioden. Hvis hÊndelsen er "Ydelsessag startet" så den forventet startdato. |
-    -    -    slutdato | date |  | 0 - 1 | Slutdato på på ydelsesperioden. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â kontaktgruppe | Â | 0 - 1 | Â | |
-    -    -    kyNoegle | string | Length: 1-100 | 0 - 1 | KYâs egen Brugervendt nÞgle pÃ¥ begreb. Denne mappes til satsniveauType i DFDG |
-    -    -    lovhenvisning | string | Length: 1-50 | 0 - 1 | §-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansÞgninger om kontanthjÊlpsydelser. Ikke udfyldt ved âYdelsessag startetâ og âYdelsessag afsluttetâ. Angives ved alle andre statusser. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â ydelsesAfgoerelsesType | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â satsniveau | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â registrerendeSagsbehandler | RegistrerendeSagsbehandlerDto | Â | 1 | RegistrationMetadata |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registrendeMyndighed | RegistrendeMyndighedDto | Â | 0 - 1 | Registrerende myndighed |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â myndighedskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed. |
-    -    -    -    sagsbehandler | SagsbehandlerDto |  | 0 - 1 | Registrerende bruger og dennes organisation (som ved fx Anden AktÞr vil vÊre forskellig fra RegisteringAuthority). |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â kalder | KalderDto | Â | 1 | Information om den kaldende bruger. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â navn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugertype | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugeridentifier | string | Length: 1-255 | 1 | Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â email | string | Pattern: ([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64}) | 0 - 1 | Brugers e-mail. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registrendeMyndighed | RegistrendeMyndighedDto | Â | 1 | Registrerende myndighed |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â myndighedskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registreringstidspunkt | date-time | Â | 1 | Kaldende systems registreringstidspunkt. |
-    -    -    -    berigtigelseskommentar | string |  | 0 - 1 | Kommentar til Êndring. |
Fejlkoder
Ingen fejlkoder