VisiteringOgStatus.VisiteringOgStatusStatusService (Version 1, 2024-3)
Siden opdateres automatisk til at afspejle koden.
Metoder
GetPersonVisiteringOgStatusStatus (GET /v1/VisiteringOgStatusStatus)
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 |
---|---|---|---|---|---|---|---|---|
A-kasse | X |
|
|
|
|
|
|
|
JobCenter |
| X |
| X | X | X |
| X |
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
visiteringogstatus.personstatus.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 | GetPersonVisiteringOgStatusStatusResponseDto |
| 1 | Svaret på forespørgslen om en borgers aktuelle helbredsmæssige begrænsninger, aktivitetstilæg, kontaktgrupper, og personkategorier. |
- helbredsbegraensninger | HelbredsbegraensningDtoCollection |
| 1 | Liste af aktuelle helbredsbegrænsninger. |
- - HelbredsbegraensningDto | HelbredsbegraensningDto |
| 0 - * |
|
- - - helbredsbegraensningId | uuid |
| 1 | GUID på den helbredsmæssige begrænsning |
- - - beskrivelseAfHelbredsbegraensning | string | Length: 1-1500 | 0 - 1 | Selvom der er forekomst 1 på Craate og Update er der 0-1 på Get-metode af hensyn til at kunne udlæse historiske data |
- - - beskrivelseAfIkkeMuligeOpgaver | string | Length: 1-1500 | 0 - 1 | Beskrivelse af ikke mulige opgaver |
- - - dokumentationForHelbredsbegrasening | boolean |
| 1 | True, hvis der foreligger dokumention for den helbredsmæssige begrænsning. Ellers false. |
- - - startdato | date-time |
| 1 | Startdato for den helbredsmæssige begrænsning |
- - - slutdato | date-time |
| 0 - 1 | Slutdato for den helbredsmæssige begrænsning |
- - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
- - - dfdgRegistreringstidspunkt | date-time |
| 1 | Hændelsesdato for registreringen |
- aktivitetstillaeg | AktivitetstillaegDtoCollection |
| 1 | Liste af aktuelle aktivitetstillæg. |
- - AktivitetstillaegDto | AktivitetstillaegDto |
| 0 - * |
|
- - - aktivitetstillaegId | uuid |
| 1 | Identifikationsnøgle for den enkelte anmodning om aktivitetstillæg. |
- - - anmodningOmAktivitetstillaeg | boolean |
| 1 | Om borgeren ønsker aktivering eller ikke. |
- - - haendelsesdato | date-time |
| 1 | Hændelsesdato for modtagelse af anmoddning om aktivitetstillæg. |
- - - slutdato | date-time |
| 0 - 1 | Slutdato for aktivitetstillæg. |
- - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar der kan angives hvis der laves ændringer. |
- - - dfdgRegistreringstidspunkt | date-time |
| 1 | Tidspunkt for registreringen i DFDG. |
- kontaktgrupper | KontaktgruppeDtoCollection |
| 1 | Samling af kontaktgrupper registreret på borger. |
- - KontaktgruppeDto | KontaktgruppeDto |
| 0 - * |
|
- - - kontaktgruppeId | uuid |
| 1 | GUID på kontaktgruppen |
- - - kontaktgruppeType |
| 1 |
| |
- - - haendelsestidspunkt | date-time |
| 1 | Kontaktgruppens hændelsestidspunkt. |
- - - starttidspunkt | date-time |
| 1 | Starttidspunkt for borgers kontaktgruppe. |
- - - sluttidspunkt | date-time |
| 0 - 1 | Sluttidspunkt for borgers kontaktgruppe. |
- - - berigtigelseskommentar | string | Length: 1-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
- personkategorier | PersonkategoriDtoCollection |
| 1 | Samling af personkategorier registreret på borger. |
- - PersonkategoriDto | PersonkategoriDto |
| 0 - * |
|
- - - personkategoriId | uuid |
| 1 | Unik nøgle. |
- - - personkategoriType |
| 0 - 1 |
| |
- - - haendelsestidspunkt | date-time |
| 1 | Angiver den dato og klokkeslet borger blev kategoriseret. |
- - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
- - - dfdgRegistreringstidspunkt | date-time |
| 1 | Tidspunkt for registreringen i DFDG. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
4404 | Person med det angivne CPR-nummer findes ikke | Person med det angivne CPR-nummer findes ikke |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |