VisiteringOgStatus.VisiteringOgStatusStatusService (Version 2, 2024-4)
Siden opdateres automatisk til at afspejle koden.
Metoder
GetPersonVisiteringOgStatusStatus (GET /v2/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, personkategorier, aktuel tilmelding og aktuelle fravÊr. |
-Â Â Â Â fritagelser | FritagelseTypeCodeListCollection | Â | 1 | Liste af fritagelser |
-Â Â Â Â -Â Â Â Â FritagelseTypeCodeList | Â | 0 - * | Â | |
-    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. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â sluttidspunkt | date-time | Â | 0 - 1 | Angiver den dato og klokkeslet borgers kategorisering blev afsluttet. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â dfdgRegistreringstidspunkt | date-time | Â | 1 | Tidspunkt for registreringen i DFDG. |
-Â Â Â Â tilmelding | TilmeldingDto | Â | 0 - 1 | Â |
-Â Â Â Â -Â Â Â Â tilmeldingIdentifier | uuid | Â | 1 | Guid for tilmeldingen |
-Â Â Â Â -Â Â Â Â klientkategori | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â tilmeldingsdato | date-time | Â | 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller Jobcentret. |
-Â Â Â Â -Â Â Â Â ledighedsgrad | Â | 1 | Â | |
-    -    haendelsesdato | date-time |  | 0 - 1 | ForretningsmÊssig hÊndelsesdato for tilmeldingen hvis den ikke er registreret på tilmeldingstidspunktet. |
-    fravaerssamling | FravaerDtoCollection |  | 1 | Samling af aktuelle (åbne og fremtidige, inkl. aktive og inaktive) fravÊr registreret på borger. |
-Â Â Â Â -Â Â Â Â FravaerDto | FravaerDto | Â | 0 - * | Â |
-    -    -    fravaerIdentifier | uuid |  | 1 | Unik nÞgle for fravÊret. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â fravaerType | Â | 1 | Â | |
-    -    -    startdato | date-time |  | 1 | Startdato for fravÊr. |
-    -    -    slutdato | date-time |  | 0 - 1 | Slutdato for fravÊr. |
-    -    -    fravaerskommentar | string | Length: 0-1500 | 0 - 1 | Kommenteret fravÊr. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â anmeldelsesdato | date-time | Â | 1 | Anmeldelsesdato. |
-    -    -    aktivt | boolean |  | 1 | Angiver om fravÊret er aktivt eller inaktivt. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â fravaersafslutningsaarsag | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentarfelt til at beskrive en berigtigelse af registreringen. |
-    -    -    nemRefusionIdentifier | uuid |  | 0 - 1 | Identifikation af om der er abonnement på sygemelding fra ydelse. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â ledighedsgrad | Â | 0 - 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â arbejdsgiver | ArbejdsgiverDto | Â | 0 - 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â cvrEnhedsid | string | MinLength: 1 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
-    -    -    -    pNummer | string |  | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid vÊre tilknyttet et CVR-nummer. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â yderligereInformationOmSygemeldingSamling | YderligereInformationOmSygemeldingDtoCollection | Â | 1 | Samling af yderligere informationer om sygemelding |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â YderligereInformationOmSygemeldingDto | YderligereInformationOmSygemeldingDto | Â | 0 - * | Â |
-    -    -    -    -    yderligereInformationIdentifier | uuid |  | 1 | Unik nÞgle for registreringen af yderligere information om fravÊr |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â yderligereInformationOmSygemeldingType | Â | 1 | Â | |
-    -    -    -    -    startdatoYderligereInformation | date-time |  | 1 | Startdato for yderligere information om fravÊr. |
-    -    -    -    -    slutDatoYderligereInformation | date-time |  | 0 - 1 | Slutdato for yderligere information om fravÊr. |
-    -    -    -    -    registreringsdatoYderligereInformation | date-time |  | 1 | Registreringsdato for yderligere information om fravÊr. |
-    -    -    -    -    berigtelseskommentarYderligereInformation | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar til yderligere information om fravÊr. |
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 |
GetFritagelser (POST /v2/VisiteringOgStatusStatus/fritagelser)
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 | Â | X | Â | Â | Â | Â |
JobCenter | Â | 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 |
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 | GetFritagelserRequestDto | Â | 1 | Â |
-    datoForFritagelser | date |  | 0 - 1 | Dato der Þnskes oplyst, om dagpengemodtager er fritaget for rådighed. Hvis den ikke angives returneres der for dags dato. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetFritagelserResponseDto | Â | 1 | Â |
-Â Â Â Â fritagelsesdato | date | Â | 0 - 1 | Dato som fritagelsen er beregnet for. |
-Â Â Â Â fritagelser | FritagelseTypeCodeListCollection | Â | 1 | Liste af borgerens fritagelser. |
-Â Â Â Â -Â Â Â Â FritagelseTypeCodeList | Â | 0 - * | Â |
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 |
4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
9461 | Borger er ikke dagpengemodtager på den angivne dato | Borger er ikke dagpengemodtager på den angivne dato |