Borgerkommunikation.BorgerkommunikationStatusService (Version 1, 2024-3)
Siden opdateres automatisk til at afspejle koden.
Metoder
GetPersonKommunikationStatus (GET /v1/BorgerkommunikationStatus)
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 |
| X |
Kommune |
| X |
| X |
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
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 | GetPersonKommunikationStatusResponseDto |
| 1 |
|
- personstatusstruktur | PersonstatusstrukturDto |
| 0 - 1 |
|
- - personnummer | 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 |
- - personstatus |
| 1 |
| |
- - navnestruktur | NavnestrukturDto |
| 0 - 1 |
|
- - - fornavne | string | Length: 1-50 | 1 | Erklæring af personens fornavn(e). |
- - - mellemnavn | string | Length: 1-40 | 0 - 1 | Erklæring af personens mellemnavne(e). |
- - - efternavn | string | Length: 1-40 | 1 | Erklæring af en persons efternavne(e). |
- - statsborgerskab |
| 1 |
| |
- - indrejsedato | date-time |
| 0 - 1 | Dato for immigrering til Danmark. |
- - bopaelskommunekode | int32 |
| 1 | Bopælskommunekode. |
- - jobcentertilknytning | JobcentertilknytningDto |
| 1 |
|
- - - jobcenterKode | int32 | Pattern: [1-9][0-9]{4} | 1 | Jobcentres kode |
- - - jobcenterNavn | string | Length: 1-100 | 1 | Jobcentres navn |
- - - kommunekodeSamling | stringCollection |
| 1 | Kommuner som jobcentret repræsenterer. |
- - - - string | string |
| 0 - * |
|
- personkommentarer | PersonkommentarDtoCollection |
| 1 | Samling af generelle statuskommentarer tilknyttet personen ud fra(populært kaldet AMP kommentarfeltet). |
- - PersonkommentarDto | PersonkommentarDto |
| 0 - * |
|
- - - personkommentarId | uuid |
| 1 | Unik nøgle |
- - - kommentar | string | Length: 1-1000 | 1 | Kommentartekst |
- - - registreringstidspunkt | date-time |
| 1 | Hændelsesdato for registreringen |
- - - sagsbehandler | SagsbehandlerDto |
| 1 |
|
- - - - brugerId | string | Length: 1-64 | 1 | Sagsbehandlerens RID fra medarbejder OCES certifikatet.. |
- - - - brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
- - - registrerendeMyndighed | RegistrerendeMyndighedDto |
| 1 |
|
- - - - organisationType |
| 0 - 1 |
| |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Myndighedskode. |
- gaesteadgange | GaesteadgangDtoCollection |
| 1 | Samling af generelle statuskommentarer tilknyttet personen ud fra(populært kaldet AMP kommentarfeltet). |
- - GaesteadgangDto | GaesteadgangDto |
| 0 - * |
|
- - - gaesteadgangId | uuid |
| 1 | Unik nøgle |
- - - gaesteadgangskommentar | string | Length: 1-1000 | 1 | Kommentartekst |
- - - dfdgRegisteringstidspunkt | date-time |
| 1 | Hændelsestidspunkt for registreringen i DFDG |
- - - registerendeBruger | SagsbehandlerDto |
| 1 |
|
- - - - brugerId | string | Length: 1-64 | 1 | Sagsbehandlerens RID fra medarbejder OCES certifikatet.. |
- - - - brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
- - - registrerendeMyndighed | RegistrerendeMyndighedDto |
| 1 |
|
- - - - organisationType |
| 0 - 1 |
| |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Myndighedskode. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
60006 | Unknown cpr | Unknown cpr |
1014 | The submitted message is not valid | The submitted message is not valid |