Versions Compared

Key

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

...

Table of Contents
maxLevel2

...

CreateKontaktgruppe (POST /v1/PersonVisitering/kontaktgruppe

...

)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneXX
STARX

...

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cprkontaktgruppeId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyCreateKontaktgruppeRequestDto1
-    kontaktgruppeIdentifieruuid0 - 1Id som medsendes i de tilfælde hvor ekstern aftager har et lokalt id ved oprettelsen
-    KontaktgruppeTypeContactGroupTypeCodeList1
-    Haendelsestidspunktdate-time0 - 1Kontaktgruppens hændelsestidspunkt i eksternt system.
-    Starttidspunktdate-time1Starttidspunkt for borgers kontaktgruppe.
-    Sluttidspunktdate-time0 - 1Sluttidspunkt for borgers kontaktgruppe.

...

FejlkodeFejltekstBeskrivelse
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
6033Kontaktgruppen er i uoverensstemmelse med borgers alderKontaktgruppen er i uoverensstemmelse med borgers alder
8096Kontaktgruppen kan ikke ændresKontaktgruppen kan ikke ændres
4703Startdatoen skal være i dagStartdatoen skal være i dag
4644Borger har allerede en åben kontaktgruppeBorger har allerede en åben kontaktgruppe
4731Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmeldingRegistrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding
4919Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgendeKontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende
8063Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidspunktHændelsestidspunkt skal være lig eller før kontaktgruppens starttidspunkt
4645Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fraværRegistrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær
9370Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforholdKontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

...

GetKontaktgrupper (

...

GET /v1/PersonVisitering/kontaktgruppe

...

)

Tilladte organisationer

Element
Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterA-kasseXFra 120 dage inden medlemskab til 120 dage efter medlemskabX
KommuneDriftsselskabXX
STARJobCenterX

Scope

visiteringogstatus.visitering.write

Input

XXXX
KommuneXX
STARX
Udbetaling Danmark (UDK)X
Udlændinge- og Integrationsministeriet (UIM)X

Scope

visiteringogstatus.visitering.kontaktgruppe.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cprkontaktgruppeId [Path]uuid

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetKontaktgrupperResponseDto1
x-requestId [Header]string    kontaktgrupperKontaktgruppeDtoCollection1Unikt 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 charsrequestBodyUpdateKontaktgruppeRequestDto1-    Sluttidspunkt
-    -    KontaktgruppeDtoKontaktgruppeDto0 - *
-    -    -    kontaktgruppeIduuid1GUID på kontaktgruppen
-    -    -    kontaktgruppeTypeContactGroupTypeCodeList1
-    -    -    haendelsestidspunktdate-time0 - 1Sluttidspunkt for borgers kontaktgruppeKontaktgruppens hændelsestidspunkt.
-    BerigtigelseskommentarstringLength: 1-    -    -    starttidspunktdate-time1Starttidspunkt for borgers kontaktgruppe.
-    -    -    sluttidspunktdate-time0 - 1Sluttidspunkt for borgers kontaktgruppe.
-    -    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar til berigtigelse af en registrering.

...

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4404Person med det angivne CPR1001Ugyldigt cpr-nummer findes ikkePerson med det angivne CPRUgyldigt cpr-nummer findes ikke
4589Id ikke fundetId ikke fundet
4919Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgendeKontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende
9370Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforholdKontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold
100028Slutdato kan ikke være fremtidigSlutdato kan ikke være fremtidig

...

1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke

UpdateKontaktgruppe (PUT /v1/PersonVisitering/kontaktgruppe/{kontaktgruppeId})

Tilladte organisationer

XX
Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgereA-kasseXFra 120 dage inden medlemskab til 120 dage efter medlemskabXDriftsselskabX
JobCenterXXXX
KommuneXX
STARXUdbetaling Danmark (UDK)XUdlændinge- og Integrationsministeriet (UIM)X

Scope

visiteringogstatus.visitering.kontaktgruppe.readwrite

Input

...

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4589Id ikke fundetId ikke fundet

CreateKontaktgruppe (POST /v1/PersonVisitering/kontaktgruppe)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgereJobCenterXXKommuneXXSTAR
ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
kontaktgruppeId [Path]uuid1

Output

...

x-requestId [Header]string1Unikt 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
requestBodyUpdateKontaktgruppeRequestDto1
-    Sluttidspunktdate-time0 - 1Sluttidspunkt for borgers kontaktgruppe.
-    BerigtigelseskommentarstringLength: 1-15000 - 1Kommentar til berigtigelse af en registrering.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4589Id ikke fundetId ikke fundet
4919Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgendeKontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende
9370Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforholdKontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold
100028Slutdato kan ikke være fremtidigSlutdato kan ikke være fremtidig

GetKontaktgruppe (GET /v1/PersonVisitering/kontaktgruppe/{kontaktgruppeId})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 120 dage efter medlemskabX
DriftsselskabXX
JobCenterXXXXX
KommuneXX
STARX
Udbetaling Danmark (UDK)X
Udlændinge- og Integrationsministeriet (UIM)X

Scope

visiteringogstatus.visitering.kontaktgruppe.writeread

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
x-requestId kontaktgruppeId [HeaderPath]string1Unikt 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 charsrequestBodyCreateKontaktgruppeRequestDtouuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetKontaktgrupperResponseDto1
-    KontaktgruppeType    kontaktgrupperContactGroupTypeCodeListKontaktgruppeDtoCollection1
-    -    Haendelsestidspunkt    KontaktgruppeDtodate-timeKontaktgruppeDto0 - 1Kontaktgruppens hændelsestidspunkt i eksternt system.-    Starttidspunktdate-time1Starttidspunkt *
-    -    -    kontaktgruppeIduuid1GUID på kontaktgruppen
-    -    -    kontaktgruppeTypeContactGroupTypeCodeList1
-    -    -    haendelsestidspunktdate-time1Kontaktgruppens hændelsestidspunkt.
-    -    -    starttidspunktdate-time1Starttidspunkt for borgers kontaktgruppe.
-    -    Sluttidspunkt    -    sluttidspunktdate-time0 - 1Sluttidspunkt for borgers kontaktgruppe.

Output

...

Fejlkoder

Beskrivelse
FejlkodeFejltekst-    -    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar til berigtigelse af en registrering.

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
6033Kontaktgruppen er i uoverensstemmelse med borgers alderKontaktgruppen er i uoverensstemmelse med borgers alder
8096Kontaktgruppen kan ikke ændresKontaktgruppen kan ikke ændres
4703Startdatoen skal være i dagStartdatoen skal være i dag
4644Borger har allerede en åben kontaktgruppeBorger har allerede en åben kontaktgruppe
4731Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmeldingRegistrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding
4919Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgendeKontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende
8063Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidspunktHændelsestidspunkt skal være lig eller før kontaktgruppens starttidspunkt
4645Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fraværRegistrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær
9370Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforholdKontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

GetKontaktgrupper (GET /v1/PersonVisitering/kontaktgruppe)

Tilladte organisationer

...

Scope

visiteringogstatus.visitering.kontaktgruppe.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

...

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke

GetKontaktgruppeHistorik (GET /v1/PersonVisitering/kontaktgruppe/historik)

Tilladte organisationer

...

Scope

visiteringogstatus.visitering.kontaktgruppe.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

...

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke

CreatePersonkategoriMedIdentifier (POST /v1/PersonVisitering/personkategori/{personkategoriId})

Tilladte organisationer

...

Scope

visiteringogstatus.visitering.write

Input

...

Output

...

Fejlkoder

FejlkodeFejltekstBeskrivelse
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8193Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppeRegistrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe
8194Personkategoriseringen kan ikke være fremtidigPersonkategoriseringen kan ikke være fremtidig
8192Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppePersonkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe
4655Borger skal afmeldes som jobsøgende inden personkategorien kan anvendesBorger skal afmeldes som jobsøgende inden personkategorien kan anvendes
4656Kategorien stemmer ikke overens med borgerens tilmeldingKategorien stemmer ikke overens med borgerens tilmelding
8190Der skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategoriDer skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategori

...

4589Id ikke fundetId ikke fundet

GetKontaktgruppeHistorik (GET /v1/PersonVisitering/kontaktgruppe/historik)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 120 dage efter medlemskabX
AUBX
JobCenterXXXXX
KommuneXX
STARX

Scope

visiteringogstatus.visitering.kontaktgruppe.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetKontaktgruppeHistorikResponseDto1
-    kontaktgruppeHistorikKontaktgruppeHistorikDtoCollection1
-    -    KontaktgruppeHistorikDtoKontaktgruppeHistorikDto0 - *
-    -    -    kontaktgruppeIduuid1GUID på kontaktgruppen
-    -    -    kontaktgruppeTypeContactGroupTypeCodeList1
-    -    -    haendelsestidspunktdate-time1Kontaktgruppens hændelsestidspunkt.
-    -    -    starttidspunktdate-time1Starttidspunkt for borgers kontaktgruppe.
-    -    -    sluttidspunktdate-time0 - 1Sluttidspunkt for borgers kontaktgruppe.
-    -    -    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar til berigtigelse af en registrering.
-    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registreringen i DFDG
-    -    -    registreringsmetadataRegistreringsmetadataDto1
-    -    -    -    erSlettetboolean1Angiver om registreringen er en sletning
-    -    -    -    erAktuelboolean1Det er en række som er aktuel (kan typisk også ses i PSS).
-    -    -    -    registrerendeMyndighedRegistrerendeMyndighedDto0 - 1
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    organisationskodestringLength: 1-201Identifikation af organisation / myndighed
-    -    -    -    -    registrerendeBrugerRegistrerendeBrugerDto0 - 1
-    -    -    -    -    -    kaldendeBrugerKaldendeBrugerDto1
-    -    -    -    -    -    -    brugerFuldtNavnstringLength: 1-1401Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.
-    -    -    -    -    -    -    brugerTypeRequestUserTypeCodeList1
-    -    -    -    -    -    -    brugerIdstringLength: 1-2551Unik 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.
-    -    -    -    -    -    -    brugerEmailemail0 - 1Brugers e-mail.
-    -    -    -    -    -    brugerOrganisationBrugerOrganisationDto1
-    -    -    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    -    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Organisationskode for den registrerende bruger.
-    -    -    -    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registrering i DFDG

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke

CreatePersonkategori (POST /v1/PersonVisitering/personkategori)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneXX
STARX

Scope

visiteringogstatus.visitering.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cprpersonkategoriId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyUpdatePersonkategoriRequestDtoCreatePersonkategoriRequestDto1Oplysninger om borgers personkategori / visitation.
-    berigtigelseskommentarstringLength: 1-15000 - 1Kommentar til berigtigelse af en registrering.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
-    personkategoriIdentifieruuid0 - 1Id som medsendes i de tilfælde hvor ekstern aftager har et lokalt id ved oprettelsen
-    kategoriTypePersonCategoryTypeCodeList1
-    haendelsestidspunktdate-time1Angiver den dato og klokkeslet hvor borgeren blev kategoriseret.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4589Id ikke fundetId ikke fundet

...

med det angivne CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8193Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppeRegistrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe
8194Personkategoriseringen kan ikke være fremtidigPersonkategoriseringen kan ikke være fremtidig
8192Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppePersonkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe
4655Borger skal afmeldes som jobsøgende inden personkategorien kan anvendesBorger skal afmeldes som jobsøgende inden personkategorien kan anvendes
4656Kategorien stemmer ikke overens med borgerens tilmeldingKategorien stemmer ikke overens med borgerens tilmelding
8190Der skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategoriDer skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategori

GetPersonkategorier (GET /v1/PersonVisitering/personkategori

...

)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
DriftsselskabXX
JobCenterXXXXX
KommuneXX
STARX
Udbetaling Danmark (UDK)X
Udlændinge- og Integrationsministeriet (UIM)X

Scope

visiteringogstatus.visitering.personkategori.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cprpersonkategoriId [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetPersonkategorierResponseDto1
-    personkategorierPersonkategoriDtoCollection1
-    -    PersonkategoriDtoPersonkategoriDto0 - *
-    -    -    personkategoriIduuid1Unik nøgle
-    -    -    personkategoriTypePersonCategoryTypeCodeList0 - 1
-    -    -    haendelsestidspunktdate-time1Angiver den dato og klokkeslet borger blev kategoriseret.
-    -    -    berigtigelseskommentarstringLength: 0-15000 - 1Kommentar til berigtigelse af en registrering.
-    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registreringen i DFDG

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4589Id ikke fundetId ikke fundet

...

-nummer findes ikke

UpdatePersonkategori (PUT /v1/PersonVisitering/personkategori/{personkategoriId})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
KommuneXX
STARX

Scope

visiteringogstatus.visitering.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
personkategoriId [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyCreatePersonkategoriRequestDtoUpdatePersonkategoriRequestDto1Oplysninger om borgers personkategori / visitation.
-    kategoriType    berigtigelseskommentarPersonCategoryTypeCodeListstringLength: 1-    haendelsestidspunkt1500date0 - time1Angiver den dato og klokkeslet hvor borgeren blev kategoriseret1Kommentar til berigtigelse af en registrering.

Output

...

Intet output

...

Fejlkoder

DetaljerForekomst
FejlkodeFejltekstBeskrivelseresponseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8193Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppeRegistrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe
8194Personkategoriseringen kan ikke være fremtidigPersonkategoriseringen kan ikke være fremtidig
8192Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppePersonkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe
4655Borger skal afmeldes som jobsøgende inden personkategorien kan anvendesBorger skal afmeldes som jobsøgende inden personkategorien kan anvendes
4656Kategorien stemmer ikke overens med borgerens tilmeldingKategorien stemmer ikke overens med borgerens tilmelding
8190Der skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategoriDer skal findes en aktiv fraværsregistrering for at kunne oprette den angivne kategori

...

CPR-nummer findes ikke
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4589Id ikke fundetId ikke fundet

GetPersonkategori (GET /v1/PersonVisitering/personkategori/{personkategoriId})

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
DriftsselskabXX
JobCenterXXXXX
KommuneXX
STARX
Udbetaling Danmark (UDK)X
Udlændinge- og Integrationsministeriet (UIM)X

Scope

visiteringogstatus.visitering.personkategori.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
personkategoriId [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetPersonkategorierResponseDto1
-    personkategorierPersonkategoriDtoCollection1
-    -    PersonkategoriDtoPersonkategoriDto0 - *
-    -    -    personkategoriIduuid1Unik nøgle
-    -    -    personkategoriTypePersonCategoryTypeCodeList0 - 1
-    -    -    haendelsestidspunktdate-time1Angiver den dato og klokkeslet borger blev kategoriseret.
-    -    -    berigtigelseskommentarstringLength: 0-15000 - 1Kommentar til berigtigelse af en registrering.
-    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registreringen i DFDG

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke
4589Id ikke fundetId ikke fundet

GetPersonkategoriHistorik (GET /v1/PersonVisitering/personkategori/historik)

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
AUBX
JobCenterXXXXX
KommuneXX
STARX

Scope

visiteringogstatus.visitering.personkategori.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetPersonkategoriHistorikResponseDto1
-    personkategoriHistorikPersonkategoriHistorikDtoCollection1
-    -    PersonkategoriHistorikDtoPersonkategoriHistorikDto0 - *
-    -    -    personkategoriIduuid1Unik nøgle
-    -    -    personkategoriTypePersonCategoryTypeCodeList0 - 1
-    -    -    haendelsestidspunktdate-time1Angiver den dato og klokkeslet borger blev kategoriseret.
-    -    -    berigtigelseskommentarstringLength: 0-15000 - 1Kommentar til berigtigelse af en registrering.
-    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registreringen i DFDG
-    -    -    registreringsmetadataRegistreringsmetadataDto1
-    -    -    -    erSlettetboolean1Angiver om registreringen er en sletning
-    -    -    -    erAktuelboolean1Det er en række som er aktuel (kan typisk også ses i PSS).
-    -    -    -    registrerendeMyndighedRegistrerendeMyndighedDto0 - 1
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    organisationskodestringLength: 1-201Identifikation af organisation / myndighed
-    -    -    -    -    registrerendeBrugerRegistrerendeBrugerDto0 - 1
-    -    -    -    -    -    kaldendeBrugerKaldendeBrugerDto1
-    -    -    -    -    -    -    brugerFuldtNavnstringLength: 1-1401Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.
-    -    -    -    -    -    -    brugerTypeRequestUserTypeCodeList1
-    -    -    -    -    -    -    brugerIdstringLength: 1-2551Unik 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.
-    -    -    -    -    -    -    brugerEmailemail0 - 1Brugers e-mail.
-    -    -    -    -    -    brugerOrganisationBrugerOrganisationDto1
-    -    -    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    -    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Organisationskode for den registrerende bruger.
-    -    -    -    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registrering i DFDG

Fejlkoder

FejlkodeFejltekstBeskrivelse
1001Ugyldigt cpr-nummerUgyldigt cpr-nummer
1010Unknown cprUnknown cpr
1014The submitted message is not validThe submitted message is not valid
4575You are not authorized to execute the operationYou are not authorized to execute the operation
4404Person med det angivne CPR-nummer findes ikkePerson med det angivne CPR-nummer findes ikke