Borgerkommunikation.MidlertidigAdresseService (Version 1[UDV], 2024-3)
Vedligeholdes af FA
Metoder
CreateMidlertidigAdresse (POST /v1/CreateMidlertidigAdresse)
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 |
---|---|---|---|---|
CreateMidlertidigAdresseRequest | CreateMidlertidigAdresseRequestType |
| 1 |
|
- 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 | Borgers personnummer |
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 |
- midlertidigAdresse | MidlertidigAdresseType |
| 1 | Angiver en evt. Registreret midlertidig adresse for personen, hvis personen står registreret med en midlertidig adresse, skal disse adresseoplysninger benyttes ved udsendelse af breve inden for det angivne datointerval som defineret af start og slutdato. |
- - startdato | DateTime |
| 1 | Startdatoen for den midlertidige adresse. |
- - slutdato | DateTime |
| 0 - 1 | Slutdatoen for den midlertidige adresse. |
- - coNavn | string | Length: 0-75 | 0 - 1 | Når personen ikke er tilmeldt folkeregisteret på sin postadresse angives navnet på en beboer på postadressen i dette felt. CoNavn på person for den midlertidige adresse. |
- - postadresse | PostAdresseType |
| 1 |
|
- - - bygningsnavn | String | Length: 1-34 | 0 - 1 | Navn på bygning |
- - - vejnavn (StreetName) | String (StreetNameType | Length: 1-50 | 1 | Vejnavn |
- - - vejnavnKort | String | Length: 1-20 | 0 - 1 | Forkortet vejnavn. Må ikke må overstige 20 tegn. |
- - - husnummer | String (StreetBuildingIdentifierType | 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 (FloorIdentifier) | String | Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$ | 0 - 1 | Etagenummer |
- - - sideDoer (SuiteIdentifier) | String | Length: 1-10 | 0 - 1 | Dør-angivelse, fx th. |
- - - supplerendeBynavn (DistrictSubdivisionIdentifier) | String | Length: 1-34 | 0 - 1 | Yderligere bynavn eller områdenavn hvor nødvendigt. |
- - - postboksnummer | String | Length: 0 - 100 | 0 - 1 | Postboksnummer |
- - - postnummer (PostCodeIdentifier) | String | 1 - 10 | 1 | Postnummer |
- - - bynavn (DistrictName) | String (DistrictNameType | Length: 1-50 | 1 | Bynavn |
- - - landekode (CountryIdentificationCode) | CountriesTypeIdentifier | Pattern: [a-zA-Z]{2} | 1 | Landekode |
- - - - baseType | _CountryIdentificationCodeType | Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4} | 1 |
|
- TemporaryResidenceForeign | TemporaryResidenceForeignType |
| 0 - 1 | Angiver en evt. Registreret midlertidig adresse i udlandet for personen, hvis personen står registreret med en midlertidig adresse i udlandet, skal disse adresseoplysninger benyttes ved udsendelse af breve inden for det angivne datointerval som defineret af start og slutdato. |
- - StartDate | dateTime |
| 1 | Startdatoen for den midlertidige adresse. |
- - EndDate | dateTime |
| 0 - 1 | Slutdatoen for den midlertidige adresse. |
- - coName | string |
| 0 - 1 | Når personen ikke er tilmeldt folkeregisteret på sin postadresse angives navnet på en beboer på postadressen i dette felt. CoNavn på person for den midlertidige adresse. |
- - AddressPostalForeign | AddressPostalForeignType |
| 1 |
|
- - - MailDeliverySublocationIdentifier | MailDeliverySublocationIdentifierType | Length: 1-34 | 0 - 1 | Navn på bygning |
- - - StreetName | StreetNameType | Length: 1-40 | 1 | Vejnavn |
- - - StreetNameForAddressingName | StreetNameForAddressingNameType | Length: 1-20 | 0 - 1 | Forkortet vejnavn. Må ikke må overstige 20 tegn. |
- - - StreetBuildingIdentifierForeign | StreetBuildingIdentifierForeignType | Pattern: [0-9]{0,6}[a-zA-Z]? | 0 - 1 | Husnummer |
- - - FloorIdentifier | FloorIdentifierType | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - SuiteIdentifier | SuiteIdentifierType | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - DistrictSubdivisionIdentifier | DistrictSubdivisionIdentifierType | Length: 1-34 | 0 - 1 | Yderligere bynavn eller områdenavn hvor nødvendigt. |
- - - PostOfficeBoxIdentifierForeign | PostOfficeBoxIdentifierForeignType | Length: 1-10 | 0 - 1 | Postboksnummer |
- - - PostCodeIdentifierForeign | PostCodeIdentifierForeignType | Length: 1-10 | 1 | Postnummer |
- - - DistrictName | DistrictNameType | Length: 1-20 | 1 | Bynavn |
- - - CountryIdentificationCode | CountryIdentificationCodeType |
| 1 | Landekode |
- - - - BaseType | _CountryIdentificationCodeType | Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4} | 1 |
|
Output (Intet output)
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
CreateMidlertidigAdresseResponse | CreateMidlertidigAdresseResponseType |
| 1 |
|
- serviceKvittering | ServiceKvitteringType |
| 1 | Service kvittering |
- - eventDato | dateTime |
| 1 |
|
- - beskedId | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
60019 | SlutDato skal være angivet for udenlandske adresser | SlutDato skal være angivet for udlandske adresser |
4403 | The start date and the end date has to be set for temporary address Der skal registreres både start- og slutdato for midlertidig adresse |
|
4376 | The maximum duration of a temporary address is 90 days Maksimal varighed for midlertidig adresse er 90 dage |
|
4402 | The end date has to be greater than start date for a temporary address Slutdatoen for midlertidig adresse skal være efter startdatoen |
|
4378 | Temporary foreign address can not be registered for persons with KontaktGruppe 2, 12, 26, 27, 28 & 29 (Kontanthælpsansøgere/modtagere, herunder efter integrationsprogram, and uddannelseshjælpsansøgere/modtagere Midlertidig udenlandsk adresse kan ikke registreres for borgere på kontanthjælpsområdet |
|
4406 | The country specified for a foreign temporary address can not be Denmark (DK) Danmark kan ikke angives som land for midlertidig udenlandsk adresse |
|
60021 | Startdato kan ikke være i fortiden |
|
60022 | Slutdato kan ikke være i fortiden |
|
4741 | Postnummer er ugyldigt | 0000-9999 |
60020 | Maksimal varighed for midlertidig adresse er 180 dage | Maksimal varighed for midlertidig adresse er 180 dage’ |
|
|
|
GetMidlertidigAdresse (GET /v1/GetMidlertidigAdresse)
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 |
---|---|---|---|---|
personNummer (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 | Borgers personnummer |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetMidlertidigAdresseResponse | GetMidlertidigAdresseResponseType |
| 1 |
|
midlertidigeAdresser | MidlertidigeAdresserDtoCollection |
| 1 | Samling af alle midlertidige adresser brugeren har haft eller har lige nu |
- midlertidigAdresse (TemporaryResidence) | MidlertidigAdresseType |
| 0 - * | Angiver en evt. Registreret midlertidig adresse for personen, hvis personen står registreret med en midlertidig adresse, skal disse adresseoplysninger benyttes ved udsendelse af breve inden for det angivne datointerval som defineret af start og slutdato. |
- - startdato (StartDate) | Date (DateTime) |
| 1 | Startdatoen for den midlertidige adresse. |
- - slutdato (EndDate) | Date |
| 0 - 1 | Slutdatoen for den midlertidige adresse. |
- - coNavn (coName) | string | Length: 0-75 | 0 - 1 | Når personen ikke er tilmeldt folkeregisteret på sin postadresse angives navnet på en beboer på postadressen i dette felt. CoNavn på person for den midlertidige adresse. |
- - postadresse (AddressPostal) | PostAdresseType |
| 1 |
|
- - - bygningsnavn (MailDeliverySublocationIdentifier) | String | Length: 1-34 | 0 - 1 | Navn på bygning |
- - - vejnavn (StreetName) | String (StreetNameType | Length: 1-50 | 1 | Vejnavn |
- - - vejnavnKort (StreetNameForAddressingName) | String | Length: 1-20 | 0 - 1 | Forkortet vejnavn. Må ikke må overstige 20 tegn. |
- - - husnummer (StreetBuildingIdentifier) | String (StreetBuildingIdentifierType | 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 (FloorIdentifier) | String | Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$ | 0 - 1 | Etagenummer |
- - - sideDoer (SuiteIdentifier) | String | Length: 1-10 | 0 - 1 | Dør-angivelse, fx th. |
- - - supplerendeBynavn (DistrictSubdivisionIdentifier) | String | Length: 1-34 | 0 - 1 | Yderligere bynavn eller områdenavn hvor nødvendigt. |
- - - postboksnummer (PostOfficeBoxIdentifier) | String | Length: 1-100 | 0 - 1 | Postboksnummer |
- - - postnummer (PostCodeIdentifier) | String | Length: 1-10 | 1 | Postnummer |
- - - bynavn (DistrictName) | String (DistrictNameType | Length: 1-50 | 1 | Bynavn |
- - - landekode (CountryIdentificationCode) | String | Pattern: [a-zA-Z]{2} | 1 | Landekode |
- - - - baseType | _CountryIdentificationCodeType | Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4} | 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
Ingen fejlkoder |
|
|
|
|
|
GetMidlertidigAdresse (GET /v1/GetMidlertidigAdresse/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 |
---|---|---|---|---|---|---|---|---|
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 |
---|---|---|---|---|
personNummer (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 | Borgers personnummer |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetMidlertidigAdresseResponse | GetMidlertidigAdresseResponseType |
| 1 |
|
midlertidigeAdresser | MidlertidigeAdresserDtoCollection |
| 1 | Samling af alle midlertidige adresser brugeren har haft eller har lige nu |
- midlertidigAdresse (TemporaryResidence) | MidlertidigAdresseType |
| 0 - * | Angiver en evt. Registreret midlertidig adresse for personen, hvis personen står registreret med en midlertidig adresse, skal disse adresseoplysninger benyttes ved udsendelse af breve inden for det angivne datointerval som defineret af start og slutdato. |
- - startdato (StartDate) | Date (DateTime) |
| 1 | Startdatoen for den midlertidige adresse. |
- - slutdato (EndDate) | Date |
| 0 - 1 | Slutdatoen for den midlertidige adresse. |
- - coNavn (coName) | string | Length: 0-75 | 0 - 1 | Når personen ikke er tilmeldt folkeregisteret på sin postadresse angives navnet på en beboer på postadressen i dette felt. CoNavn på person for den midlertidige adresse. |
- - postadresse (AddressPostal) | PostAdresseType |
| 1 |
|
- - - bygningsnavn (MailDeliverySublocationIdentifier) | String | Length: 1-34 | 0 - 1 | Navn på bygning |
- - - vejnavn (StreetName) | String (StreetNameType | Length: 1-50 | 1 | Vejnavn |
- - - vejnavnKort (StreetNameForAddressingName) | String | Length: 1-20 | 0 - 1 | Forkortet vejnavn. Må ikke må overstige 20 tegn. |
- - - husnummer (StreetBuildingIdentifier) | String (StreetBuildingIdentifierType | 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 (FloorIdentifier) | String | Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$ | 0 - 1 | Etagenummer |
- - - sideDoer (SuiteIdentifier) | String | Length: 1-10 | 0 - 1 | Dør-angivelse, fx th. |
- - - supplerendeBynavn (DistrictSubdivisionIdentifier) | String | Length: 1-34 | 0 - 1 | Yderligere bynavn eller områdenavn hvor nødvendigt. |
- - - postboksnummer (PostOfficeBoxIdentifier) | String | Length: 1-100 | 0 - 1 | Postboksnummer |
- - - postnummer (PostCodeIdentifier) | String | Length: 1-10 | 1 | Postnummer |
- - - bynavn (DistrictName) | String (DistrictNameType | Length: 1-50 | 1 | Bynavn |
- - - landekode (CountryIdentificationCode) | String | Pattern: [a-zA-Z]{2} | 1 | Landekode |
- - 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 |
---|---|---|
Ingen fejlkoder |
|
|
|
|
|