VisiteringOgStatus.AktivitetstillaegService (Version 1, 2024-1)
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateAktivitetstillaeg (POST /v1/Aktivitetstillaeg)
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 | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.aktivitetstillaeg.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 | CreateAktivitetstillaegRequestDto |  | 1 | Oplysninger om borgers anmodning om aktivitetstillÊg |
-    anmodningOmAktivitetstillaeg | boolean |  | 1 | True, borger Þnsker at blive aktivereret. Ellers false. |
-    haendelsesdato | date-time |  | 1 | HÊndelsesdato for modtagelse af anmodning om aktivitetstillÊg. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid | Â | 1 | Â |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
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 |
6023 | Anmodning om aktivitetstillÊg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder | Anmodning om aktivitetstillÊg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder |
6031 | Den nye hÊndelsesdato er fÞr hÊndelses- eller slutdato for et allerede registrereret anmodning | Den nye hÊndelsesdato er fÞr hÊndelses- eller slutdato for et allerede registrereret anmodning |
100040 | AktivitetstillÊg må ikke have hÊndelsesdato efter 01.07.2025 | AktivitetstillÊg må ikke have hÊndelsesdato efter 01.07.2025 |
GetAktivitetstillaeg (GET /v1/Aktivitetstillaeg)
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 | Â | X |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.aktivitetstillaeg.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 | GetAktivitetstillaegResponseDto | Â | 1 | Â |
-    aktivitetstillaeg | AktivitetstillaegDtoCollection |  | 1 | Samling af aktivitetstillÊg registreret på borger |
-Â Â Â Â -Â Â Â Â 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 |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
GetAktivitetstillaegHistorik (GET /v1/Aktivitetstillaeg/historik)
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 | Â | X |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.aktivitetstillaeg.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 | GetAktivitetstillaegHistorikResponseDto | Â | 1 | Â |
-Â Â Â Â aktivitetstillaegHistorik | AktivitetstillaegHistorikDtoCollection | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â AktivitetstillaegHistorikDto | AktivitetstillaegHistorikDto | Â | 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 |
-Â Â Â Â -Â Â Â Â -Â Â Â Â registreringsmetadata | RegistreringsmetadataDto | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â erSlettet | boolean | Â | 1 | Angiver om registreringen er en sletning |
-    -    -    -    erAktuel | boolean |  | 1 | Det er en rÊkke som er aktuel (kan typisk også ses i PSS). |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registrerendeMyndighed | RegistrerendeMyndighedDto | Â | 0 - 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â registrerendeBruger | RegistrerendeBrugerDto | Â | 0 - 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â kaldendeBruger | KaldendeBrugerDto | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerId | 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. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerEmail | Â | 0 - 1 | Brugers e-mail. | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â brugerOrganisation | BrugerOrganisationDto | Â | 1 | Â |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationType | Â | 1 | Â | |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Organisationskode for den registrerende bruger. |
-Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â -Â Â Â Â dfdgRegistreringstidspunkt | date-time | Â | 1 | Tidspunkt for registrering i DFDG |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
1010 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |
UpdateAktivitetstillaeg (PUT /v1/Aktivitetstillaeg/{aktivitetstillaegId})
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 | Â | Â | Â |
STAR | X | Â | Â | Â | Â | Â | Â | Â |
Scope
visiteringogstatus.aktivitetstillaeg.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 |
aktivitetstillaegId [Path] | uuid | Â | 1 | Â |
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 | UpdateAktivitetstillaegRequestDto |  | 1 | Oplysninger om borgers anmodning om aktivitetstillÊg |
-    anmodningOmAktivitetstillaeg | boolean |  | 1 | True, borger Þnsker at blive aktivereret. Ellers false. |
-    haendelsesdato | date-time |  | 1 | HÊndelsesdato for modtagelse af anmodning om aktivitetstillÊg. |
-    slutdato | date-time |  | 0 - 1 | Slutdato for anmodnings gyldighed som fÞlge af kontaktgruppe skift, skift i visitationsgruppe eller afslutning af kontaktgruppe |
-Â Â Â Â berigtigelseskommentar | string | Length: 1-1500 | 1 | Kommentarfelt til at beskrive en berigtigelse af en registrering. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
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 |
4589 | Id ikke fundet | Id ikke fundet |
4933 | Kommentaren må ikke indeholde HTML | Kommentaren må ikke indeholde HTML |
6023 | Anmodning om aktivitetstillÊg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder | Anmodning om aktivitetstillÊg er ikke gyldig ift. borgers kontaktgruppe, visitation eller alder |
6030 | Slutdatoen skal vÊre senere end startdatoen | Slutdatoen skal vÊre senere end startdatoen |
6031 | Den nye hÊndelsesdato er fÞr hÊndelses- eller slutdato for et allerede registrereret anmodning | Den nye hÊndelsesdato er fÞr hÊndelses- eller slutdato for et allerede registrereret anmodning |
100040 | AktivitetstillÊg må ikke have hÊndelsesdato efter 01.07.2025 | AktivitetstillÊg må ikke have hÊndelsesdato efter 01.07.2025 |