Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Vedligeholdes af FA

Metoder

...

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateMidlertidigAdresseRequest
(SavePersonTemporaryAddressRequest)

CreateMidlertidigAdresseRequestType
(SavePersonTemporaryAddressRequestType)

1

-    x-civilregistrationIdentifier [Header]
(PersonCivilRegistrationIdentifier)

String
(PersonCivilRegistrationIdentifierType
Base: 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
(TemporaryResidence)

MidlertidigAdresseType
(TemporaryResidenceType)

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
(StartDate)

DateTime

1

Startdatoen for den midlertidige adresse.

-    -    slutdato
(EndDate)

DateTime

0 - 1
(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
(AddressPostalType)

1

-    -    -    bygningsnavn
(MailDeliverySublocationIdentifier)

String
(MailDeliverySublocationIdentifierType
Base: string)

Length: 1-34

0 - 1

Navn på bygning

-    -    -    vejnavn

(StreetName)

String

(StreetNameType
Base: string)

Length: 1-50

1

Vejnavn

-    -    -    vejnavnKort
(StreetNameForAddressingName)

String
(StreetNameForAddressingNameType
Base: string)

Length: 1-20

0 - 1

Forkortet vejnavn. Må ikke må overstige 20 tegn.

-    -    -    husnummer
(StreetBuildingIdentifier)

String

(StreetBuildingIdentifierType
Base: 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

(FloorIdentifier)

String
(FloorIdentifierType
Base: string)

Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$

0 - 1

Etagenummer

-    -    -    sideDoer

(SuiteIdentifier)

String
(SuiteIdentifierType
Base: string)

Length: 1-10

0 - 1

Dør-angivelse, fx th.

-    -    -    supplerendeBynavn

(DistrictSubdivisionIdentifier)

String
(DistrictSubdivisionIdentifierType
Base: string)

Length: 1-34

0 - 1

Yderligere bynavn eller områdenavn hvor nødvendigt.

-    -    -    postboksnummer
(PostBoxIdentifier)

String
(PostOfficeBoxIdentifierType
Base: string)

Length: 0 - 100

0 - 1

Postboksnummer

-    -    -    postnummer

(PostCodeIdentifier)

String
(PostCodeIdentifierType
Base: string)

1 - 10

1

Postnummer

-    -    -    bynavn

(DistrictName)

String

(DistrictNameType
Base: string)

Length: 1-50

1

Bynavn

-    -    -    landekode

(CountryIdentificationCode)

CountriesTypeIdentifier
String
(CountryIdentificationCodeType
Base: _CountryIdentificationCodeType)

Pattern: [a-zA-Z]{2}

1

Landekode

-    -    -    -    baseType

_CountryIdentificationCodeType
Base: string

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.
(occurrence kan kun være 0 for personer med cpr status inaktiv – ’Grænsegængere’)

-    -    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
Base: string

Length: 1-34

0 - 1

Navn på bygning

-    -    -    StreetName

StreetNameType
Base: string

Length: 1-40

1

Vejnavn

-    -    -    StreetNameForAddressingName

StreetNameForAddressingNameType
Base: string

Length: 1-20

0 - 1

Forkortet vejnavn. Må ikke må overstige 20 tegn.

-    -    -    StreetBuildingIdentifierForeign

StreetBuildingIdentifierForeignType
Base: string

Pattern: [0-9]{0,6}[a-zA-Z]?

0 - 1

Husnummer

-    -    -    FloorIdentifier

FloorIdentifierType
Base: string

Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]

0 - 1

Etagenummer

-    -    -    SuiteIdentifier

SuiteIdentifierType
Base: string

Length: 1-4

0 - 1

Dør-angivelse, fx th.

-    -    -    DistrictSubdivisionIdentifier

DistrictSubdivisionIdentifierType
Base: string

Length: 1-34

0 - 1

Yderligere bynavn eller områdenavn hvor nødvendigt.

-    -    -    PostOfficeBoxIdentifierForeign

PostOfficeBoxIdentifierForeignType
Base: string

Length: 1-10

0 - 1

Postboksnummer

-    -    -    PostCodeIdentifierForeign

PostCodeIdentifierForeignType
Base: string

Length: 1-10

1

Postnummer

-    -    -    DistrictName

DistrictNameType
Base: string

Length: 1-20

1

Bynavn

-    -    -    CountryIdentificationCode

CountryIdentificationCodeType
Base: _CountryIdentificationCodeType

1

Landekode

-    -    -    -    BaseType

_CountryIdentificationCodeType
Base: string

Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4}

1

...

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

  • Midlertidig udenlandsk adresse kan ikke registreres for borgere på kontanthjælpsområdet - fejlkode 4378 'Temporary foreign address can not be registered for persons with ClientCategory 2, 4, 6, 7, 8 and 9 (Kontanthælpsansøgere/modtagere, herunder efter integrationsprogram, and uddannelseshjælpsansøgere/modtagere'

    • Clientcategory 2 og 4 → KG2 ('kontanthjælpsmodtager)

    • Clientcategory 6 og 7 → KG 26 ('Overgangsydelsesansøger omfattet af LAB'), 27 ('Selvforsørgelses-/hjemrejsesydelsesansøger efter INL'), 29 ('Overgangsydelsesansøger efter INL')

    • Clientcategory 8 og 9 → KG 12 ('Uddannelseshjælpsmodtager') og 28 ('Uddannelsespålæg - Overgangsydelsesmodtager efter LAB')

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)

...

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
(TemporaryResidenceType)

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    startdato

(StartDate)

Date

(DateTime)

1

Startdatoen for den midlertidige adresse.

-    - slutDatoslutdato

(EndDate)

Date
(DateTime)

0 - 1
(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.

-    - postAdressepostadresse

(AddressPostal)

PostAdresseType
(AddressPostalType)

1

-    -    - bygningsNummerbygningsnavn

(MailDeliverySublocationIdentifier)

String
(MailDeliverySublocationIdentifierType
Base: string)

Length: 1-34

0 - 1

Navn på bygning

-    -    - vejnavn

(StreetName)

String

(StreetNameType
Base: string)

Length: 1-50

1

Vejnavn

-    -    - vejnavnKort

(StreetNameForAddressingName)

String
(StreetNameForAddressingNameType
Base: string)

Length: 1-20

0 - 1

Forkortet vejnavn. Må ikke må overstige 20 tegn.

-    -    - husnummer

(StreetBuildingIdentifier)

String

(StreetBuildingIdentifierType
Base: 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

(FloorIdentifier)

String
(FloorIdentifierType
Base: string)

Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$

0 - 1

Etagenummer

-    -    - sideDoer

(SuiteIdentifier)

String
(SuiteIdentifierType
Base: string)

Length: 1-10

0 - 1

Dør-angivelse, fx th.

-    -    - supplerendeBynavn

(DistrictSubdivisionIdentifier)

String
(DistrictSubdivisionIdentifierType
Base: string)

Length: 1-34

0 - 1

Yderligere bynavn eller områdenavn hvor nødvendigt.

-    -    - postBoksNummerpostboksnummer

(PostOfficeBoxIdentifier)

String
(PostOfficeBoxIdentifierType
Base: integer)

Length: 1-100

0 - 1

Postboksnummer

-    -    - postNummerpostnummer

(PostCodeIdentifier)

String
(PostCodeIdentifierType
Base: string)

Length: 1-10

1

Postnummer

-    -    - byNavnbynavn

(DistrictName)

String

(DistrictNameType
Base: string)

Length: 1-50

1

Bynavn

-    -    - landeKodelandekode

(CountryIdentificationCode)

String
(CountryIdentificationCodeType
Base: _CountryIdentificationCodeType)

Pattern: [a-zA-Z]{2}

1

Landekode

-    -    -    - baseType

_CountryIdentificationCodeType
Base: string

Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4}

1

...

GetMidlertidigAdresse (GET /v1/GetMidlertidigAdresse/Historik)

Tilladte  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

Fra 120 dage inden medlemskab til 120 dage efter medlemskab

 x

x

 

 

 

 

JobCenter

 

x

 

x

x

x

 

x

Kommune

 

x

 

x

 

 

 

 

STAR

x

 

 

 

 

 

 

 


Scope

borgerkommunikation.midlertidigadresse.read

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetMidlertidigAdresseRequest

GetMidlertidigAdresseRequestType

 

1

 

personNummer

(PersonCivilRegistrationIdentifier)

String
(PersonCivilRegistrationIdentifierType
Base: 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

...

Detaljer

Forekomst

Beskrivelse

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
(TemporaryResidenceType)

 

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

    startdato

(StartDate)

Date

(DateTime)

 

1

Startdatoen for den midlertidige adresse.

-

slutDato

- slutdato

(EndDate)

Date
(DateTime)

 

0 - 1
(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

postadresse

(AddressPostal)

PostAdresseType
(AddressPostalType)

 

1

 

- -    -

bygningsNummer

bygningsnavn

(MailDeliverySublocationIdentifier)

String
(MailDeliverySublocationIdentifierType
Base: string)

Length: 1-34

0 - 1

Navn på bygning

- -    -

vejNavn

vejnavn

(StreetName)

String

(StreetNameType
Base: string)

Length: 1-50

1

Vejnavn

- -    -

vejNavnKort

vejnavnKort

(StreetNameForAddressingName)

String
(StreetNameForAddressingNameType
Base: string)

Length: 1-20

0 - 1

Forkortet vejnavn. Må ikke må overstige 20 tegn.

- -    -

husNummer

husnummer

(StreetBuildingIdentifier)

String

(StreetBuildingIdentifierType
Base: string)

Pattern: ^(?:[0-9]{0,6}[a-zA-Z]


(([1-9]|

|([1-9][0-9]

|[1-9][0-9]{2})|([1-9][A-Z]|[1-9][0-9][A-Z]|[

{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[

A

a-zA-Z]?)?)$

1

Husnummer

- -    - etage

(FloorIdentifier)

String
(FloorIdentifierType
Base: string)

Pattern: ^([1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9])$

0 - 1

Etagenummer

- -    - sideDoer

(SuiteIdentifier)

String
(SuiteIdentifierType
Base: string)

Length: 1-10

0 - 1

Dør-angivelse, fx th.

- -    - supplerendeBynavn

(DistrictSubdivisionIdentifier)

String
(DistrictSubdivisionIdentifierType
Base: string)

Length: 1-34

0 - 1

Yderligere bynavn eller områdenavn hvor nødvendigt.

- -    -

postBoksNummer

postboksnummer

(PostOfficeBoxIdentifier)

String
(PostOfficeBoxIdentifierType
Base: integer)

Length: 1-100

0 - 1

Postboksnummer

- -    -

postNummer

postnummer

(PostCodeIdentifier)

String
(PostCodeIdentifierType
Base: string)

Length: 1-10

1

Postnummer

- -    -

byNavn

bynavn

(DistrictName)

String

(DistrictNameType
Base: string)

Length: 1-50

1

Bynavn

- -    -

landeKode

landekode

(CountryIdentificationCode)

String
(CountryIdentificationCodeType
Base: _CountryIdentificationCodeType)

Pattern: [a-zA-Z]{2}

1

Landekode

-    -    registreringsmetadata

RegistreringsmetadataDto

 

1

 

-    -    -

baseType

_CountryIdentificationCodeType
Base: string

Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}

    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

OrganisationTypeCodeList

 

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

RequestUserTypeCodeList

 

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

email

 

0 - 1

Brugers e-mail.

-    -    -    -    -    brugerOrganisation

BrugerOrganisationDto

 

1

 

-    -    -    -    -    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    -    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{

4

1,8}
MinLength: 1

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Tidspunkt for registrering i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Ingen fejlkoder