Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Siden opdateres automatisk til at afspejle koden.

Metoder

GetPersonKommunikationStatus (GET /v5/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

borgerkommunikation.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

personstatusstruktur [Query]

boolean

0 - 1

personkommentarer [Query]

boolean

0 - 1

gaesteadgang [Query]

boolean

0 - 1

personnummerHistorik [Query]

boolean

0 - 1

adresse [Query]

boolean

0 - 1

midlertidigAdresse [Query]

boolean

0 - 1

boernUnder18 [Query]

boolean

0 - 1

andenaktoerhenvisning [Query]

boolean

0 - 1

personFagprofessionelKontakt [Query]

boolean

0 - 1

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetPersonKommunikationStatusResponseDto

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
MinLength: 1

1

Borgers personnummer

-    personstatusstruktur

PersonstatusstrukturDto

0 - 1

-    -    personstatus

PersonCivilRegistrationStatusTypeCodeList

1

-    -    navnestruktur

NavnestrukturDto

0 - 1

-    -    -    fornavne

string

Length: 1-50

1

Erklæring af personens fornavn(e).

-    -    -    mellemnavn

string

Length: 0-40

0 - 1

Erklæring af personens mellemnavne(e).

-    -    -    efternavn

string

Length: 1-40

1

Erklæring af en persons efternavne(e).

-    -    statsborgerskab

LandeTypeIdentifierCodeList

1

-    -    indrejsedato

date-time

0 - 1

Dato for immigrering til Danmark.

-    -    foedselsdato

date-time

1

Borgers fødselsdato.

-    -    bopaelskommunekode

int32

0 - 1

Bopælskommunekode. Udstilles for kommunenr. 101 - 851. Ellers tom.

-    -    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. Af tekniske årsager har denne elementlistes elementer ikke navn og beskrivelse.

-    -    -    -    string

string

0 - *

-    - akassetilknytning

AkassetilknytningDto

0 - 1

Seneste a-kasse medlemsskab

-    -    -    akassekode

EksterneData.AkasseTypeCodeList

MinInclusive: 0
MaxInclusive: 99

1

Kode på a-kasse.

-    -    -    afdelingskontorKode

EksterneData.AkasseAfdelingskontorTypeCodeList

MinInclusive: 0
MaxInclusive: 999999

0 - 1

Kode på a-kasse afdelingskontor.

-    -    -    medlemskabsstartdato    

date

 

1

Dato og tidspunkt for registreing af medlemskab i A-kasse

-    -    -    medlemskabophoersdato

date

 

0 - 1

Slutdato for medlemskab

-    -    -    forsikringskategori

Borgerkommunikation.ForsikringskategoriTypeCodeList

 

1

Forsikringskategori Heltid eller deltidsforsikret.

-    -    -    dagepengeretsdato

date

 

0 - 1

Dato og tidspunkt givende medlem af A-kasse er berettigede til dagpenge.

-    -    borgersKoen

KoenTypeCodeList

0 - 1

-    -    nordiskBorger

boolean

0 - 1

Angiver om borgeren er nordisk statsborger

-    -    civilstatus

CivilstandsTypeCodeList

0 - 1

-    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

OrganisationTypeCodeList

0 - 1

-    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
Length: 1-20

1

Myndighedskode.

-    gaesteadgange

GaesteadgangDtoCollection

1

Samling af gaesteadgange.

-    -    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

OrganisationTypeCodeList

0 - 1

-    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
Length: 1-20

1

Myndighedskode.

-    personnummerHistorik

TidligereCPRnummerDtoCollection

1

Samling af tidligere personnummre.

-    -    TidligereCPRnummerDto

TidligereCPRnummerDto

0 - *

-    -    -    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
MinLength: 1

1

Tidligere CPR-nummer

-    -    -    personnummerstatus

PersonCivilRegistrationStatusTypeCodeList

1

-    -    -    slutdato

date-time

0 - 1

Slutdato for borgers CPR-nrs gyldighed

-    adressestruktur

AdressestrukturDto

0 - 1

-    -    navneOgAdressebeskyttelseStartdato

date-time

0 - 1

Startdato for navne og adresse beskyttelse

-    -    navneOgAdressebeskyttelseSlutdato

date-time

0 - 1

Slutdato for navne og adresse beskyttelse

-    -    adresse

AdresseDto

0 - 1

-    -    -    coNavn

string

0 - 1

-    -    -    vejnavn

string

Length: 1-40

1

-    -    -    husnummer

string

Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)(-[1-9][0-9]{0,2}[a-zA-Z]?)?$
MinLength: 1

1

-    -    -    etage

string

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

0 - 1

-    -    -    sideDoer

string

Length: 0-4

0 - 1

-    -    -    bygningsnummer

string

0 - 1

-    -    -    bynavn

string

Length: 0-34

0 - 1

-    -    -    postnummer

string

Pattern: [0-9]{4}
MinLength: 1

1

-    -    -    postdistrikt

string

Length: 1-20

1

-    -    -    landekode

string

Pattern: ^(?:[a-zA-Z]{2}|[a-zA-Z]{3}|[0-9]{3}|[0-9]{4})?$

0 - 1

-    -    darAdresse

string

0 - 1

-    -    geokoordinatStruktur

GeokoordinatStrukturDto

0 - 1

-    -    -    breddegrad

double

1

-    -    -    laengdegrad

double

1

-    temporaryAddress

MidlertidigAdresseDto

0 - 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]?)?)$
MinLength: 1

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}$
MinLength: 1

1

Landekode

-    boernUnder18

BoernUnder18DtoCollection

1

Børn under 18

-    -    BoernUnder18Dto

BoernUnder18Dto

0 - *

-    -    -    foedselsdato

date-time

1

Barnets fødselsdaton

-    -    -    maandeOgAarFor18Aar

string

Length: 7-7

1

Måned hvor barnet fylder 18 år i formatet MM/YYYY, fx 12/2016

-    -    -    opholdsland

LandeTypeIdentifierCodeList

1

-    andenAktoerHenvisninger

AndenAktoerHenvisningDtoCollection

1

Samling af Anden Aktoer Henvisninger

-    -    AndenAktoerHenvisningDto

AndenAktoerHenvisningDto

0 - *

-    -    -    henvisningsId

uuid

1

Unik identifikation af anden aktør henvisning

-    -    -    eksternSystemAftaleId

uuid

0 - 1

Id på delaftale i det ekstern system

-    -    -    cvrEnhedsid

string

Pattern: [0-9]{8}
MinLength: 1

1

Anden aktørs CVR-nummer.

-    -    -    pNummer

string

Pattern: [0-9]{10}
MinLength: 1

1

P-nr på anden aktør

-    -    -    startDato

date

1

Dato for anden aktør henvisningens start.

-    -    -    slutDato

date

1

Dato for anden aktør henvisningens afslutning.

-    -    -    dfdgRegisteringstidspunkt

date-time

1

Dato for anden aktør henvisningens start.

-    -    -    erAnnulleret

boolean

1

Om Anden Aktør henvisning er annulleret eller ej

-    -    -    kommentar

string

0 - 1

Kommentar

-    -    -    sagsbehandler

AndenAktoerHenvisningSagsbehandlerDto

1

-    -    -    -    brugerFuldtNavn

string

MaxLength: 140

0 - 1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

-    -    -    -    brugerId

string

Length: 1-64

1

Sagsbehandlerens RID fra medarbejder OCES certifikatet..

-    -    -    registrerendeMyndighed

RegistrerendeMyndighedDto

1

-    -    -    -    organisationType

OrganisationTypeCodeList

0 - 1

-    -    -    -    organisationskode

string

Pattern: [-][1]|[0-9]{1,8}
Length: 1-20

1

Myndighedskode.

-    fagprofessionelleKontakter

PersonFagprofessionelKontaktDtoCollection

1

Samling af Fagprofessionelle Kontakter

-    -    PersonFagprofessionelKontaktDto

PersonFagprofessionelKontaktDto

0 - *

-    -    -    fagprofessionelKontaktId

uuid

0 - 1

Identifikation af kontaktpersontilknytningen. Hvis kontaktpersonen er mentor eller udslusningskoordinator er værdien null.

-    -    -    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    -    -    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

1

-    -    -    eksternKontaktReference

string

Length: 0-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    -    -    telefonnummer

string

Pattern: ^(?:\+?[0-9]{3,20})?$

0 - 1

Kontaktens telefonnummer inkl. landekode

-    -    -    mobilnummer

string

Pattern: ^(?:\+?[0-9]{3,20})?$

0 - 1

Kontaktens mobilnummer inkl. landekode

-    -    -    emailadresse

string

Pattern: ^(?:([^>\(\)\[\]\\,;:@\s]{0,191}@[^>\(\)\[\]\\,;:@\s]{1,64}))?$

0 - 1

Kontaktens emailadresse

-    -    -    startDato

date-time

1

Startdato og tidspunkt for tilknytningen af kontakten

-    -    -    slutDato

date-time

0 - 1

Slutdato og tidspunkt for tilknytningen af kontakten

-    -    -    kontaktSkalVisesForBorger

boolean

1

Indikator for, om kontakten med denne rolle skal vises for borger på Jobnet.
Bemærk ikke alle roller vises på Jobnet.

-    -    -    kommentarTilBorger

string

Length: 0-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet.

-    -    -    kommentarTilSagsbehandler

string

Length: 0-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter.

-    -    -    ansvarligMyndighedDto

AnsvarligMyndighedDto

1

-    -    -    -    organisationType

OrganisationTypeCodeList

1

-    -    -    -    organisationCode

string

Pattern: [-][1]|[0-9]{1,8}
MinLength: 1

1

Organisationskode.
Hvis uddannelsesinstitution så institutionsnummer. Hvis andet end myndighed så CVR-nummer

-    -    -    -    clientSystemType

ClientSystemTypeCodeList

1

-    -    -    -    cvrnummer

string

Pattern: ^(?:[0-9]{8})?$

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    -    -    produktionsenhedsnummer

string

Pattern: ^(?:[0-9]{10})?$

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Slutdato og tidspunkt for tilknytningen af kontakten

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

60006

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

  • No labels