Borgerkommunikation.PersonkommentarService (Version 2, 2024-3)

Siden opdateres automatisk til at afspejle koden.

Metoder

GetPersonkommentarer (GET /v2/Personkommentar)

Henter alle personkommentarer for en borger.

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

 

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

 

 

Kommune

 

X

 

X

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetPersonkommentarResponseDto

 

1

 

-    personkommentarer

PersonCommentDtoCollection

 

1

 

-    -    PersonCommentDto

PersonCommentDto

 

0 - *

 

-    -    -    personkommentarId

uuid

 

1

Unik nøgle

-    -    -    kommentar

string

Length: 1-1000

1

Kommentartekst

-    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Hændelsesdato for registreringen

-    -    -    sagsbehandler

SagsbehandlerDto

 

1

 

-    -    -    -    brugerId

string

Length: 1-64

1

Den organisation som registrerende bruger tilhører.

-    -    -    -    brugerFuldtNavn

string

Length: 1-140

1

Tidspunkt for registrering i DFDG

-    -    -    registrerendeMyndighed

RegistrerendeOrganisationDto

 

1

 

-    -    -    -    organisationType

OrganisationTypeCodeList

 

0 - 1

 

-    -    -    -    organisationskode

string

Length: 1-20

1

Identifikation af organisation / myndighed

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

60006

Unknown cpr

Unknown cpr

CreatePersonkommentar (POST /v2/Personkommentar)

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

 

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

 

 

 

X

 

 

JobCenter

 

X

 

 

X

 

 

 

Kommune

 

X

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

CreatePersonkommentarRequestDto

 

1

 

-    kommentar

string

Length: 1-1000

1

Kommentarfelt til at beskrive en berigtigelse af en registrering

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

uuid

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Ugyldigt cpr-nummer

Ugyldigt cpr-nummer

4933

Kommentaren må ikke indeholde HTML

Kommentaren må ikke indeholde HTML

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

GetPersonkommentar (GET /v2/Personkommentar/{personkommentarId})

Henter en specifik person kommentar for en borger.

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

 

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

 

 

Kommune

 

X

 

X

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

personkommentarId [Path]

uuid

 

1

 

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

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetPersonkommentarResponseDto

 

1

 

-    personkommentarer

PersonCommentDtoCollection

 

1

 

-    -    PersonCommentDto

PersonCommentDto

 

0 - *

 

-    -    -    personkommentarId

uuid

 

1

Unik nøgle

-    -    -    kommentar

string

Length: 1-1000

1

Kommentartekst

-    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Hændelsesdato for registreringen

-    -    -    sagsbehandler

SagsbehandlerDto

 

1

 

-    -    -    -    brugerId

string

Length: 1-64

1

Den organisation som registrerende bruger tilhører.

-    -    -    -    brugerFuldtNavn

string

Length: 1-140

1

Tidspunkt for registrering i DFDG

-    -    -    registrerendeMyndighed

RegistrerendeOrganisationDto

 

1

 

-    -    -    -    organisationType

OrganisationTypeCodeList

 

0 - 1

 

-    -    -    -    organisationskode

string

Length: 1-20

1

Identifikation af organisation / myndighed

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

60006

Unknown cpr

Unknown cpr

UpdatePersonkommentar (PUT /v2/Personkommentar/{personkommentarId})

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

 

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

 

X

 

 

 

 

JobCenter

X

 

 

 

X

 

 

 

Kommune

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

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

UpdatePersonkommentarRequestDto

 

1

 

-    kommentar

string

Length: 1-1000

1

Kommentarfelt til at beskrive en berigtigelse af en registrering

-    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentarfelt til at beskrive en berigtigelse af en registrering.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

4683

Berigtigelseskommentar skal udfyldes

Berigtigelseskommentar skal udfyldes

4933

Kommentaren må ikke indeholde HTML

Kommentaren må ikke indeholde HTML

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

DeletePersonkommentar (DELETE /v2/Personkommentar/{personkommentarId})

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

 

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

 

X

 

 

 

 

JobCenter

X

 

 

 

X

 

 

 

Kommune

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

personkommentarId [Path]

uuid

 

1

 

berigtigelseskommentar [Query]

string

 

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

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

4683

Berigtigelseskommentar skal udfyldes

Berigtigelseskommentar skal udfyldes

4933

Kommentaren må ikke indeholde HTML

Kommentaren må ikke indeholde HTML

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

GetPersonkommentarerHistorik (GET /v2/Personkommentar/historik)

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

 

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

 

 

Kommune

 

X

 

X

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetPersonkommentarHistorikResponseDto

 

1

 

-    personkommentarerHistorik

PersonkommentarHistorikDtoCollection

 

1

 

-    -    PersonkommentarHistorikDto

PersonkommentarHistorikDto

 

0 - *

 

-    -    -    personkommentarId

uuid

 

1

Identifier for kommentar

-    -    -    kommentar

string

MinLength: 1

1

Kommentartekst

-    -    -    registreringstidspunkt

date-time

 

1

Hændelsesdato for registreringen

-    -    -    berigtigelseskommentar

string

 

0 - 1

Kommentar til berigtigelse af en registrering.

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

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

60006

Unknown cpr

Unknown cpr

UpdatePersonkommentarLegacy (PUT /v2/Personkommentar/{personkommentarId}/legacy)

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

 

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

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.staronly.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

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

UpdatePersonkommentarRequestDto

 

1

 

-    kommentar

string

Length: 1-1000

1

Kommentarfelt til at beskrive en berigtigelse af en registrering

-    berigtigelseskommentar

string

Length: 0-1500

0 - 1

Kommentarfelt til at beskrive en berigtigelse af en registrering.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

4683

Berigtigelseskommentar skal udfyldes

Berigtigelseskommentar skal udfyldes

4933

Kommentaren må ikke indeholde HTML

Kommentaren må ikke indeholde HTML

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

DeletePersonkommentarLegacy (DELETE /v2/Personkommentar/{personkommentarId}/legacy)

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

 

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

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.personkommentar.staronly.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

personkommentarId [Path]

uuid

 

1

 

berigtigelseskommentar [Query]

string

 

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

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4589

Id ikke fundet

Id ikke fundet

4683

Berigtigelseskommentar skal udfyldes

Berigtigelseskommentar skal udfyldes

4933

Kommentaren må ikke indeholde HTML

Kommentaren må ikke indeholde HTML

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead