VisiteringOgStatus.VisiteringOgStatusStatusService (Version 3 [UDV], 2025-2)
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. |
- - Afmelding | AfmeldingDto |
| 0 - 1 |
|
- - - afmeldedato | date-time |
| 1 | Afmeldingsdato. |
- - - afmeldingsaarsag |
| 1 |
| |
- 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. |
(ScreeningSelfService) |
|
| 1 | Samling af spørgeskema oplysninger i forhold til borger |
(ScreeningAllowed) | boolean |
| 1 | Angiver om borgeren har mulighed for at gennemføre spørgeskema |
(ScreeningCompleted) | boolean |
| 1 | Angiver om der findes et skørgeskemaresultat for den pågældende borger - på tværs af eventuelle ledighedsperioder. ledighedsperiode |
(ScreeningCompletedDate) | dateTime |
| 0 - 1 | Angiver dato for gennemført spørgeskema. |
(ScreeningCategory) | VisiteringOgStatus.MaalgruppeForSpoergeskemaTypeCodeList Erstatter Enumeration:
|
| 1 | Angiver, hvilket spørgeskema borgeren skal gennemføre. Dette har indflydelse på, hvilken tekst borgeren præsenteres for ved påbegyndelse af screening |
Note til 1005.17.21 KY @2025-1
(SocialAidCollection) | SocialAidTypeCollection |
| 0 - 1 | Liste af kontanthjælpsbevillinger. |
(GetSocialAidType) | YdelseDto |
| 0 - * | Konkrete ydelsesperiode |
(PersonCivilRegistrationIdentifier) | 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 | Borgerens cpr-nummer |
(KYSocialAidIdentifier) | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Unik nøgle på ydelsessagen i KY |
(StartDate) | date |
| 1 | Startdato på ydelsesperioden. Hvis hændelsen er "Ydelsessag startet" så den forventet startdato. |
(EndDate) | date |
| 0 - 1 | Slutdato på på ydelsesperioden. |
(ContactGroupTypeIdentifier) | https://starwiki.atlassian.net/wiki/spaces/FYS/pages/3990490581 (Gl. DFDG ContactGroupTypeIdentifierType) |
| 0 - 1 | Resultatet af afgørelsen om ydelse hvis positivt dvs. ydelse gives. Resultat angives i form af DFDG kontaktgruppe |
| String | Length: 1-100 | 0 -1 | KY’s egen Brugervendt nøgle på begreb. Denne mappes til satsniveauType i DFDG |
|
|
| 0 - 1 | Udfyldes vedr. ansøgninger om kontanthjælp. Ikke udfyldt ved “Ydelsessag startet”. Angives ved alle andre statusser. |
| String | Length: 1-50 | 0 - 1 | §-henvisning til Lov om aktiv socialpolitik. Udfyldes vedr. ansøgninger om kontanthjælpsydelser. Ikke udfyldt ved “Ydelsessag startet”. Angives ved alle andre statusser. |
(AppropriationOutcomeTypeIdentifier) | VisiteringOgStatus.YdelsesAfgoerelsesTypeKodeliste (gl DFDG AppropriationOutcomeTypeIdentifierType) |
| 0 - 1 | Hændelse fra ydelse, enten at - Ydelsessag startet - Ydelse er givet - Ydelse er afvist - Ydelse stoppet - Ydelsessag afsluttet |
(SocialAidIdentifier) | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Unik nøgle på ydelsessagen 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 |
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 |
GetSelvbetjening (GET /v1/selvbetjening/{})
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
getSelvbetjeningRequest | GetSelvbetjeningRequestDto |
| 1 |
|
- x-civilRegistrationIdentifier [Header] (PersonCivilRegistrationIdentifier) | 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 | Borgerens personnummer. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
gGetSelvbetjeningResponse | GetSelvbetjeningResponseDto |
| 1 |
|
- selvbetjeningsmuligheder | SelvbetjeningsmulighederDto |
| 1 | Liste med borgers selvbetjeningsmuligheder |
- - selvbetjeningsmulighed | SelvbetjeningsmulighedDto |
| 0 - * | Borgers selvbetjeningsmulighed |
- - - mulighed |
| 1 | Kode for selvbetjening der er mullig for borger |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |