Borgerkommunikation.MidlertidigAdresseService (Version 1, 2024-3)
Siden opdateres automatisk til at afspejle koden.
Metoder
GetMidlertidigAdresse (GET /v1/MidlertidigAdresse)
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
borgerkommunikation.midlertidigadresse.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 | CreateMidlertidigAdresseResponseDto |
| 1 |
|
- midlertidigAdresse | MidlertidigAdresseDtoCollection |
| 0 - 1 | Samling af alle midlertidige adresser brugeren har eller har haft |
- - MidlertidigAdresseDto | MidlertidigAdresseDto |
| 0 - * |
|
- - - startdato | date-time |
| 1 | Startdato for midlertidigadresse |
- - - slutdato | date-time |
| 0 - 1 | Slutdato for midlertidigadresse |
- - - coNavn | string | MaxLength: 75 | 0 - 1 | Navn på Co |
- - - postadresse | PostAdresseDto |
| 1 |
|
- - - - bygningsnavn | string | Length: 1-34 | 0 - 1 | Navn på bygning |
- - - - vejnavn | string | Length: 1-40 | 1 | Vejnavn |
- - - - vejnavnKort | string | Length: 1-20 | 0 - 1 | Vejnavn |
- - - - husnummer | string | Pattern: ^(?:[0-9]{0,6}[a-zA-Z]|([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?)$ | 1 | Husnummer |
- - - - etage | string | Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$ | 0 - 1 | Etagenummer |
- - - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - - supplerendeBynavn | string | Length: 1-34 | 0 - 1 | Yderligere bynavn eller områdenavn hvor nødvendigt. |
- - - - postboksnummer | string | Length: 1-10 | 0 - 1 | Postboksnummer |
- - - - postnummer | string | Length: 1-10 | 1 | Postnummer |
- - - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - - landekode | string | Pattern: ^[a-zA-Z]{2}$ | 1 | Landekode |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
60006 | Unknown cpr | Unknown cpr |
CreateMidlertidigAdresse (POST /v1/MidlertidigAdresse)
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 |
|
|
|
Kommune |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerkommunikation.midlertidigadresse.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 | CreateMidlertidigAdresseRequestDto |
| 1 |
|
- startdato | date-time |
| 1 | Startdato for midlertidigadresse |
- slutdato | date-time |
| 0 - 1 | Slutdato for midlertidigadresse |
- coNavn | string | MaxLength: 75 | 0 - 1 | Navn på Co |
- postadresse | PostAdresseDto |
| 1 |
|
- - bygningsnavn | string | Length: 1-34 | 0 - 1 | Navn på bygning |
- - vejnavn | string | Length: 1-40 | 1 | Vejnavn |
- - vejnavnKort | string | Length: 1-20 | 0 - 1 | Vejnavn |
- - husnummer | string | Pattern: ^(?:[0-9]{0,6}[a-zA-Z]|([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?)$ | 1 | Husnummer |
- - etage | string | Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$ | 0 - 1 | Etagenummer |
- - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - supplerendeBynavn | string | Length: 1-34 | 0 - 1 | Yderligere bynavn eller områdenavn hvor nødvendigt. |
- - postboksnummer | string | Length: 1-10 | 0 - 1 | Postboksnummer |
- - postnummer | string | Length: 1-10 | 1 | Postnummer |
- - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - landekode | string | Pattern: ^[a-zA-Z]{2}$ | 1 | Landekode |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1001 | Ugyldigt cpr-nummer | Ugyldigt cpr-nummer |
4376 | Midlertidig adresse må ikke vare længere end 180 dage | Midlertidig adresse må ikke vare længere end 180 dage |
4378 | Midlertidig udenlandsk adresse kan ikke registreres for borgere på kontanthjælpsområdet | Midlertidig udenlandsk adresse kan ikke registreres for borgere på kontanthjælpsområdet |
4401 | Midlertidig adresse slut dato kan ikke være før start dato | Midlertidig adresse slut dato kan ikke være før start dato |
4402 | Slutdatoen for midlertidig adresse skal være efter dags dato | Slutdatoen for midlertidig adresse skal være efter dags dato |
4403 | Slutsdato skal være sat for midlertidige adresser, hvor borger ikke er udrejst | Slutsdato skal være sat for midlertidige adresser, hvor borger ikke er udrejst |
4741 | Det angivne post nummer er ikke gyldigt | Det angivne post nummer er ikke gyldigt |
4933 | Kommentaren må ikke indeholde HTML | Kommentaren må ikke indeholde HTML |
60006 | Unknown cpr | Unknown cpr |
60007 | The person with specified cpr is dead | The person with specified cpr is dead |
60019 | Start dato for midlertidig adresse kan ikke være i fortiden. | Start dato for midlertidig adresse kan ikke være i fortiden. |
60020 | Dansk postboksnummer skal være mellem 1 og 9999 | Dansk postboksnummer skal være mellem 1 og 9999 |