Siden opdateres automatisk til at afspejle koden.
Metoder
Table of Contents | ||
---|---|---|
|
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, 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 | 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. | ||||
- SpoergeskemaSelvbetjening (ScreeningSelfService) | 1 | Samling af spørgeskema oplysninger i forhold til borger | |||||
- - sporgeskemaTilgaengeligt (ScreeningAllowed) | boolean |
| 1 | Angiver om borgeren har mulighed for at gennemføre spørgeskema | |||
- - sporgeskemaGennemfoert (ScreeningCompleted) | boolean |
| 1 | Angiver om der findes et skørgeskemaresultat for den pågældende borger - på tværs af eventuelle ledighedsperioder. ledighedsperiode | |||
- - gennemfoerelsesTidspunkt gennemfoerelsestidspunkt (ScreeningCompletedDate) | dateTime |
| 0 - 1 | Angiver dato for gennemført spørgeskema. | |||
- - spoergeskemaMaalgruppe (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. | ||||
- tilmelding | tildmeldingDtoCollection | 1 | Samling af tilmeldinger registreret på borger. | - - TilmeldingRequestDto | TilmeldingRequestDtotilmeldingType | 0 - * | |
- - - 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 | CreateTilmeldingRequestDto |
| 1 |
| |||
- - - TilmeldingId | 1 | Den aktuelle tilmelding for borger. | |||||
- - TilmeldingIdentifier | uuid | 1 | Guid for tilmeldingen | ||||
- - - Klientkategori ClientCategoryTypeIdentifier | TilmeldekategoriTypeCodeList (ClientCategoryTypeIdentifierType) |
| 1 | Tilmeldekategori (tidligere også betegnet som klientkategori) | |||
- - - Tilmeldingsdato EnrollmentDate | dateTime |
| 1 | Tilmeldedatoen hvor det angivne tilmeldeforhold starter. Dette er datoen, hvor den ledige har henvendt sig enten gennem Jobnet eller Jobcentret. | |||
- - - Ledighedsgrad CurrentUnemploymentStatusTypeIdentifier | LedighedsgradTypeCodeList (CurrentUnemploymentStatusTypeIdentifierType) |
| 1 | Ledighedsgrad. | |||
- - - Haendelsesdato | dateTime |
| 0 - 1 | Forretningsmæssig hændelsesdato for tilmeldingen hvis den ikke er registreret på | |||
- fravaerfravaerssamling | fravaerDtoCollection | 1 | Samling af | Fravaer aktuelle (åbne og fremtidige, incl. aktive og inaktive) fravær registreret på borger. | |||
- - FravaerRequestDtoFravaerRequestDtofravaer | FravaersType | 0 - * | Indeholder data til en fraværsregistrering | ||||
- - - FravaerTypefravaerIdentifier | GUIDFravaersType | (GUID) | 1Indeholder data til en fraværsregistrering | Unik nøgle for fraværet | |||
- - - - FravaersTypeIdfravaerType | FravaerTypeCodeList CodeListItemIdentifierType | MaxInclusive: 10000 | 1 | Typeangivelse for fravær. | |||
- - - - StartDatoStartdato | dateTime |
| 1 | Startdato for fravær | |||
- - - - SlutDatoSlutdato | dateTime |
| 0 - 1 | Slutdato for fravær | |||
- - - - FravaersKommentarFravaerskommentar | FravaersKommentarType | Length: 0-1500 | 0 - 1 | Kommenteret fravær. | |||
- - - - NotifikationsDatoAnmeldelsesdato | dateTime |
| 1 | Anmeldelsesdato | |||
- - - Aktivt | Boolean | 1 | Felt, der angiver om forholdet er aktivt eller inaktivt. | ||||
- - - FravaersAarsagTypeIdFravaersafslutningsaarsag | FravaersafslutningsaarsagTypeCodeList | MaxInclusive: 10000 | 0 - 1 | Identifikation af årsagstype for fravær. | |||
- - - RettelsesKommentarberigtigelseskommentar | RettelsesKommentarType Base: string | Length: 0-1500 | 0 - 1 | Kommentarfelt til at beskrive en berigtigelse af en registrering. | |||
- - - NemrefusionIdentifier | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Identifikation af om der er abonnement på sygemelding fra ydelse. | |||
- - - Ledighedsgrad (CurrentUnemploymentStatusTypeIdentifier) | LedighedsgradTypeCodeList (CurrentUnemploymentStatusTypeIdentifierType) | 0 - 1 | Ledighedsgrad. | ||||
(CompanyIdentifier) | ArbejdsgiverDto |
| 0 - 1 | Virksomhedsinformation på borgers arbejdsgiver ved sygemelding fra beskæftigelse. | |||
- - - - Pnummer (ProductionUnitIdentifier) | PenhednummeridentifierType | Length: 10 | 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. | |||
- - - - cvrEnhedsid (CVRnumberIdentifier) | CVRnummeridentifierType | Length: 8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. | |||
- - - YderligereInformationOmSygemeldingSamling (AdditionalInformationOnAbsenceTypeCollection) | YderligereinformationomfravaertyperDtoCollection | 0 - 1 | Samling af yderligere informationer om fravær | ||||
- - - - YderligereInformationOmSygemelding (AdditionalInformationOnAbsenceType) | YderligereinformationomfravaertypeDto | 0 - * | |||||
- - - - - YderligereInformationIdentifier (MessageIdentifier) | 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 for YdeligereInformationOmFravaer | |||
- - - - - YderligereInformationOmSygemeldingType (AdditionalInformationOnAbsenceTypeIdentifier) | YderligereInformationOmFravaerTypeCodeList | 1 | Typen af den yderligere information om fravær | ||||
- - - - - StartdatoYderligereInformation (StartDate) | dateTime | 1 | Startdato for yderligere information om fravær | ||||
- - - - - SlutDatoYderligereInformation (EndDate) | dateTime | 0 - 1 | Slutdato for yderligere information om fravær | ||||
- - - - - RegistreringsdatoYderligereInformation (RegistrationDate) | dateTime | 1 | Registreringsdato for yderligere information om fravær | ||||
- - - - - BerigtigelsekommentarYderligereInformation (CorrectionComment) | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar til yderligere information om fravær | |||
| PersonExemptTypeIdentifierTypeCollection |
| 1 | Liste af borgerens fritagelser. | |||
| FritagelseTypeCodeList |
| 0 - * | N/A | |||
Note til 1005.17.21 KY @2024-3 - ydelser (SocialAidCollection) | SocialAidTypeCollection |
| 0 - 1 | Liste af kontanthjælpsbevillinger. | |||
- - ydelse (SocialAidType) | YdelseDto |
| 0 - * | Konkrete ydelsesperiode | |||
- - - kyYdelsesIdentifier (MessageIdentifier) | 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 | |||
- - - startdato (StartDate) | dateTime |
| 1 | Startdato. | |||
- - - slutdato (EndDate) | dateTime |
| 0 - 1 | Slutdato. | |||
- - - klientkategori (ClientCategoryTypeIdentifier) | VisiteringOgStatus.ClientCategoryTypeCodeList (Gl. DFDG ClientCategoryTypeIdentifierType) |
| 1 | Angivelse af klientkategori fra ydelsessystemets ved afgørelse om ydelse. |
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 | Person med det angivne CPR-nummer er død | Person med det angivne 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) (tidl. GetPersonExempts)
Metode som returnerer om dagpengemodtager er fritaget for rådighed på en given dato.
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 | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X |
|
|
|
|
JobCenter |
| X |
| X | X | X |
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
Request |
| 1 |
| |
| 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 | Borgers personnummer. |
| 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 | ResponseType |
| 1 |
|
| date |
| 1 | Dato som fritagelsen er beregnet for |
| PersonExemptInfoType |
| 0 - 1 | Information om dagpengemodtager er fritaget eller ej |
| PersonExemptTypeIdentifierTypeCollection |
| 1 | Liste af borgerens fritagelser. |
| FritagelseTypeCodeList |
| 0 - * | N/A |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1014 | Failed to validate message | The submitted message could not be validated |
4385 | ¤(oversættelse findes allerede?) | The client does not have an unemploymentfund registration |
4575 | You are not authorized | You are not authorized to execute the operation |
9461 | Borger er ikke dagpengemodtager på den angivne dato | The citizen is not in Contactgroup 1 on the indicated date |