VisiteringOgStatus.PersonVisiteringService (Version 1, 2024-3)

JobCenter

Kommune

STAR

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

CreateKontaktgruppeRequestDto

1

-    kontaktgruppeIdentifier

uuid

0 - 1

Id som medsendes i de tilfælde hvor ekstern aftager har et lokalt id ved oprettelsen

-    KontaktgruppeType

ContactGroupTypeCodeList

1

-    Haendelsestidspunkt

date-time

0 - 1

Kontaktgruppens hændelsestidspunkt i eksternt system.

-    Starttidspunkt

date-time

1

Starttidspunkt for borgers kontaktgruppe.

-    Sluttidspunkt

date-time

0 - 1

Sluttidspunkt for borgers kontaktgruppe.

response

uuid

1

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

6033

Kontaktgruppen er i uoverensstemmelse med borgers alder

Kontaktgruppen er i uoverensstemmelse med borgers alder

8096

Kontaktgruppen kan ikke ændres

Kontaktgruppen kan ikke ændres

4703

Startdatoen skal være i dag

Startdatoen skal være i dag

4644

Borger har allerede en åben kontaktgruppe

Borger har allerede en åben kontaktgruppe

4731

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding

4919

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

8063

Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidspunkt

Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidspunkt

4645

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær

9370

Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

A-kasse

Driftsselskab

JobCenter

Kommune

STAR

Udbetaling Danmark (UDK)

Udlændinge- og Integrationsministeriet (UIM)

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

response

GetKontaktgrupperResponseDto

1

-    kontaktgrupper

KontaktgruppeDtoCollection

1

-    -    KontaktgruppeDto

KontaktgruppeDto

0 - *

-    -    -    kontaktgruppeId

uuid

1

GUID på kontaktgruppen

-    -    -    kontaktgruppeType

ContactGroupTypeCodeList

1

-    -    -    haendelsestidspunkt

date-time

1

Kontaktgruppens hændelsestidspunkt.

-    -    -    starttidspunkt

date-time

1

Starttidspunkt for borgers kontaktgruppe.

-    -    -    sluttidspunkt

date-time

0 - 1

Sluttidspunkt for borgers kontaktgruppe.

-    -    -    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

JobCenter

Kommune

STAR

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

kontaktgruppeId [Path]

uuid

1

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

UpdateKontaktgruppeRequestDto

1

-    Sluttidspunkt

date-time

0 - 1

Sluttidspunkt for borgers kontaktgruppe.

-    Berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4589

Id ikke fundet

Id ikke fundet

4919

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

9370

Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

100028

Slutdato kan ikke være fremtidig

Slutdato kan ikke være fremtidig

A-kasse

Driftsselskab

JobCenter

Kommune

STAR

Udbetaling Danmark (UDK)

Udlændinge- og Integrationsministeriet (UIM)

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

kontaktgruppeId [Path]

uuid

1

response

GetKontaktgrupperResponseDto

1

-    kontaktgrupper

KontaktgruppeDtoCollection

1

-    -    KontaktgruppeDto

KontaktgruppeDto

0 - *

-    -    -    kontaktgruppeId

uuid

1

GUID på kontaktgruppen

-    -    -    kontaktgruppeType

ContactGroupTypeCodeList

1

-    -    -    haendelsestidspunkt

date-time

1

Kontaktgruppens hændelsestidspunkt.

-    -    -    starttidspunkt

date-time

1

Starttidspunkt for borgers kontaktgruppe.

-    -    -    sluttidspunkt

date-time

0 - 1

Sluttidspunkt for borgers kontaktgruppe.

-    -    -    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4589

Id ikke fundet

Id ikke fundet

A-kasse

AUB

JobCenter

Kommune

STAR

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

response

GetKontaktgruppeHistorikResponseDto

1

-    kontaktgruppeHistorik

KontaktgruppeHistorikDtoCollection

1

-    -    KontaktgruppeHistorikDto

KontaktgruppeHistorikDto

0 - *

-    -    -    kontaktgruppeId

uuid

1

GUID på kontaktgruppen

-    -    -    kontaktgruppeType

ContactGroupTypeCodeList

1

-    -    -    haendelsestidspunkt

date-time

1

Kontaktgruppens hændelsestidspunkt.

-    -    -    starttidspunkt

date-time

1

Starttidspunkt for borgers kontaktgruppe.

-    -    -    sluttidspunkt

date-time

0 - 1

Sluttidspunkt for borgers kontaktgruppe.

-    -    -    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registreringen i DFDG

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

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]{1,8}
MinLength: 1

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registrering i DFDG

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

JobCenter

Kommune

STAR

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

CreatePersonkategoriRequestDto

1

Oplysninger om borgers personkategori / visitation

-    personkategoriIdentifier

uuid

0 - 1

Id som medsendes i de tilfælde hvor ekstern aftager har et lokalt id ved oprettelsen

-    kategoriType

PersonCategoryTypeCodeList

1

-    haendelsestidspunkt

date-time

1

Angiver den dato og klokkeslet hvor borgeren blev kategoriseret.

response

uuid

1

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

8193

Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe

Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe

8194

Personkategoriseringen kan ikke være fremtidig

Personkategoriseringen kan ikke være fremtidig

8192

Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe

Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe

4655

Borger skal afmeldes som jobsøgende inden personkategorien kan anvendes

Borger skal afmeldes som jobsøgende inden personkategorien kan anvendes

4656

Kategorien stemmer ikke overens med borgerens tilmelding

Kategorien stemmer ikke overens med borgerens tilmelding

8190

Der skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategori

Der skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategori

Driftsselskab

JobCenter

Kommune

STAR

Udbetaling Danmark (UDK)

Udlændinge- og Integrationsministeriet (UIM)

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

response

GetPersonkategorierResponseDto

1

-    personkategorier

PersonkategoriDtoCollection

1

-    -    PersonkategoriDto

PersonkategoriDto

0 - *

-    -    -    personkategoriId

uuid

1

Unik nøgle

-    -    -    personkategoriType

PersonCategoryTypeCodeList

0 - 1

-    -    -    haendelsestidspunkt

date-time

1

Angiver den dato og klokkeslet borger blev kategoriseret.

-    -    -    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registreringen i DFDG

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

JobCenter

Kommune

STAR

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

personkategoriId [Path]

uuid

1

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

UpdatePersonkategoriRequestDto

1

Oplysninger om borgers personkategori / visitation.

-    berigtigelseskommentar

string

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4405

Borgeren med det specificerede CPR nummer er død

Borgeren med det specificerede CPR nummer er død

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4589

Id ikke fundet

Id ikke fundet

Driftsselskab

JobCenter

Kommune

STAR

Udbetaling Danmark (UDK)

Udlændinge- og Integrationsministeriet (UIM)

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

personkategoriId [Path]

uuid

1

response

GetPersonkategorierResponseDto

1

-    personkategorier

PersonkategoriDtoCollection

1

-    -    PersonkategoriDto

PersonkategoriDto

0 - *

-    -    -    personkategoriId

uuid

1

Unik nøgle

-    -    -    personkategoriType

PersonCategoryTypeCodeList

0 - 1

-    -    -    haendelsestidspunkt

date-time

1

Angiver den dato og klokkeslet borger blev kategoriseret.

-    -    -    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registreringen i DFDG

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4589

Id ikke fundet

Id ikke fundet

AUB

JobCenter

Kommune

STAR

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

response

GetPersonkategoriHistorikResponseDto

1

-    personkategoriHistorik

PersonkategoriHistorikDtoCollection

1

-    -    PersonkategoriHistorikDto

PersonkategoriHistorikDto

0 - *

-    -    -    personkategoriId

uuid

1

Unik nøgle

-    -    -    personkategoriType

PersonCategoryTypeCodeList

0 - 1

-    -    -    haendelsestidspunkt

date-time

1

Angiver den dato og klokkeslet borger blev kategoriseret.

-    -    -    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

-    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registreringen i DFDG

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

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]{1,8}
MinLength: 1

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    -    dfdgRegistreringstidspunkt

date-time

1

Tidspunkt for registrering i DFDG

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

1010

Unknown cpr

Unknown cpr

1014

The submitted message is not valid

The submitted message is not valid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke