...
| 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 |
| 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 | ContactGroupTypeCodeListKontaktgruppeTypeCodeList | 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. |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetKontaktgrupperResponseDto | 1 | ||
| - kontaktgrupper | KontaktgruppeDtoCollection | 1 | ||
| - - KontaktgruppeDto | KontaktgruppeDto | 0 - * | ||
| - - - kontaktgruppeId | uuid | 1 | GUID på kontaktgruppen | |
| - - - kontaktgruppeType | ContactGroupTypeCodeListKontaktgruppeTypeCodeList | 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. |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetKontaktgrupperResponseDto | 1 | ||
| - kontaktgrupper | KontaktgruppeDtoCollection | 1 | ||
| - - KontaktgruppeDto | KontaktgruppeDto | 0 - * | ||
| - - - kontaktgruppeId | uuid | 1 | GUID på kontaktgruppen | |
| - - - kontaktgruppeType | ContactGroupTypeCodeListKontaktgruppeTypeCodeList | 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. |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetKontaktgruppeHistorikResponseDto | 1 | ||
| - kontaktgruppeHistorik | KontaktgruppeHistorikDtoCollection | 1 | ||
| - - KontaktgruppeHistorikDto | KontaktgruppeHistorikDto | 0 - * | ||
| - - - kontaktgruppeId | uuid | 1 | GUID på kontaktgruppen | |
| - - - kontaktgruppeType | ContactGroupTypeCodeListKontaktgruppeTypeCodeList | 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 | 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 |
...
| 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 |
| 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 | PersonCategoryTypeCodeListPersonkategoriTypeCodeList | 1 | ||
| - haendelsestidspunkt | date-time | 1 | Angiver den dato og klokkeslet hvor borgeren blev kategoriseret. |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetPersonkategorierResponseDto | 1 | ||
| - personkategorier | PersonkategoriDtoCollection | 1 | ||
| - - PersonkategoriDto | PersonkategoriDto | 0 - * | ||
| - - - personkategoriId | uuid | 1 | Unik nøgle | |
| - - - personkategoriType | PersonCategoryTypeCodeListPersonkategoriTypeCodeList | 0 - 1 | ||
| - - - haendelsestidspunkt | date-time | 1 | Angiver den dato og klokkeslet borger blev kategoriseret. | |
| - - - Sluttidspunkt | date-time | 0 - 1 | Angiver den dato og klokkeslet kategorisering blev lukket. | |
| - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
| - - - dfdgRegistreringstidspunkt | date-time | 1 | Tidspunkt for registreringen i DFDG |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetPersonkategorierResponseDto | 1 | ||
| - personkategorier | PersonkategoriDtoCollection | 1 | ||
| - - PersonkategoriDto | PersonkategoriDto | 0 - * | ||
| - - - personkategoriId | uuid | 1 | Unik nøgle | |
| - - - personkategoriType | PersonCategoryTypeCodeListPersonkategoriTypeCodeList | 0 - 1 | ||
| - - - haendelsestidspunkt | date-time | 1 | Angiver den dato og klokkeslet borger blev kategoriseret. | |
| - - - Sluttidspunkt | date-time | 0 - 1 | Angiver den dato og klokkeslet kategorisering blev lukket. | |
| - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
| - - - dfdgRegistreringstidspunkt | date-time | 1 | Tidspunkt for registreringen i DFDG |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetPersonkategoriHistorikResponseDto | 1 | ||
| - personkategoriHistorik | PersonkategoriHistorikDtoCollection | 1 | ||
| - - PersonkategoriHistorikDto | PersonkategoriHistorikDto | 0 - * | ||
| - - - personkategoriId | uuid | 1 | Unik nøgle | |
| - - - personkategoriType | PersonCategoryTypeCodeListPersonkategoriTypeCodeList | 0 - 1 | ||
| - - - haendelsestidspunkt | date-time | 1 | Angiver den dato og klokkeslet borger blev kategoriseret. | |
| - - - Sluttidspunkt | date-time | 0 - 1 | Angiver den dato og klokkeslet kategorisering blev lukket. | |
| - - - 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 | 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 |
...