Borgerkommunikation.PersonkommentarService (Version 1 [UDV] 2023-1)

Owned by Joel Järlesäter (Unlicensed)
Last updated: Mar 20, 2023 by Jesper BrunholmVersion comment
2 min read

Denne service gør det muligt at registrere og opdatere generelle statuskommentarer på en person.

Metoder

GetPersonkommentarer (GET /personkommentar/)

Denne metode benyttes til at hente alle kommentarer, for en given borger.

Operation

Endpoint

Operation

Endpoint

GET

v1/personkommentar/

Input

[Personnummer i header]

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Personkommentarer
(PersonCommentCollection)

IEnumerable<PersonkommentarDto>
(PersonCommentTypeCollection)

 

1

Samling af generelle statuskommentarer tilknyttet personen ud fra (populært kaldet AMP kommentarfeltet).

-    Personkommentarstruktur
(PersonCommentType)

PersonkommentarDto
(PersonCommentType)

 

0 - *

 

-    -    PersonkommentarId
(MessageIdentifier)

guid

 

1

Unik nøgle

- -    Kommentar
(CommentText)

string

Length: 1-1000

1

Kommentartekst

-    -    DfdgRegistreringstidspunkt
(EventDate)

dateTime

 

1

Hændelsesdato for registreringen

-    -    RegistrerendeBruger
(CaseWorkerStructure)

RegistrerendeBrugerDto
(CaseWorkerStructureType)

 

1

Registrerende sagsbehandler.

- - - BrugerFuldtNavn

string

Length: 1-140

 

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

-    -    -    Fornavn
(CaseWorkerGivenName)

string

Length: 1-50

1

Sagsbehandlerens fornavn

-    -    -    Mellemnavn
(CaseWorkerMiddleName)

string

MaxLength: 40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    Efternavn
(CaseWorkerSurname)

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    BrugerId
(CaseWorkerRID)

string

Length: 1-64

1

Sagsbehandlerens id.

-    -    RegistrerendeMyndighed
(AuthorityStructure)

RegistrerendeMyndighedDto

 

1

Detaljer på myndigheden.

-    -    -    Organisationskode

(AuthorityCode)

string

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

1

Myndighedskode.

-    -    -    OrganisationType
(OrganisationTypeIdentifier)

https://starwiki.atlassian.net/wiki/spaces/UDV/pages/45220143

(OrganisationTypeIdentifierType)

1

Myndighedstype.

-    -    -    AuthorityName

string

 

1

Myndighedsnavn.

e

GetPersonkommentarerHistorik (GET /personkommentar/historik)

Denne metode benyttes til at hente historik for alle kommentarer, for en given borger.

Operation

Endpoint

Operation

Endpoint

GET

v1/personkommentar/historik

Input

[Personnummer i header]

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

PersonkommentarHistorikResponse

PersonkommentarHistorikResponseDto

 

 

 

- PersonkommentarHistorik
(CommentHistoryCollection)

IEnumerable<PersonkommentarHistorikDto>
(CommentTypeCollection)

 

0 - 1

Liste af aktuelle og historiske kommentarer.

-    -    PersonkommentarId
(CommentIdentifier)

guid

 

1

Identifier for kommentar

- - Kommentar

(CommentText)

string

Length: 1-1000

1

Kommentartekst

- - Registreringstidspunkt

(EventDate)

dateTime

 

1

Hændelsesdato for registreringen

-    -    Berigtigelseskommentar
(CorrectionComment)

string

 

0 - 1

Kommentar til berigtigelse af en registrering.

  • -    -    BaseType

ServiceModelBase

 

1

 

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

 

-    -    -    -    -    -    Organisattionskode

string

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

1

Organisationskode for den registrerende bruger.

-    -    -    -    -    DfdgRegistreringstidspunkt

date-time

 

1

Tidspunkt for registrering i DFDG

CreatePersonkommentar (POST /personkommentar/)

Denne metode benyttes til at oprette en kommentar på en person

Operation

Endpoint

Operation

Endpoint

POST

v1/personkommentar/

Input

[Personnummer i header]

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateRequest

CreateRequestType

 

1

 

-    CommentText

CommentType
Base: string

Length: 1-1000

1

Kommentarfelt til at beskrive en berigtigelse af en registrering

Output

Task<Guid> hvor guiden er kommentarens id

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

(CreateResponse)

(CreateResponseType)

 

1

 

-    (ServiceReceipt)

(ServiceReceiptType)

 

1

 

-    -    (EventDate)

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

-    -    (MessageIdentifier)

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1001

Invalid cpr

The submitted cpr is either to long or short or contains data not interpretable as a date

1010

Unknown cpr

The submitted cpr is unknown to the system

4405

The person with specified cpr is dead

The person with specified cpr is dead

4933

The comment text cannot contain html tags

The comment text cannot contain html tags

UpdatePersonkommentar (PUT /personkommentar/{kommentarId})

Denne metode benyttes til at opdaterer en general statuskommentar på en person

Operation

Endpoint

Operation

Endpoint

PUT

v1/personkommentar/{kommentarId}

Input

[Personnummer i header]

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

PersonkommentarId

Guid

 

 

 

UpdatePersonkommentarRequest
(UpdateRequest)

UpdatePersonkommentarRequestDto
(UpdateRequestType)

 

1

 

-    Kommentar
(CommentText)

string

Length: 1-1000

1

Kommentarfelt til at beskrive en berigtigelse af en registrering

-    Berigtigelseskommentar
(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentarfelt til at beskrive en berigtigelse af en registrering.

Output

Intet andet end status.

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

UpdateResponse

UpdateResponseType

 

1

 

-    ServiceReceipt

ServiceReceiptType

 

1

 

-    -    EventDate

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

-    -    MessageIdentifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4933

The comment text cannot contain html tags

The comment text cannot contain html tags

4683

The CorrectionComment must contain content

The CorrectionComment must contain content

DeletePersonkommentar (Delete /personkommentar/{kommentarId})

Denne metode benyttes til at slette en kommentar på en person

Operation

Endpoint

Operation

Endpoint

DELETE

v1/personkommentar/{kommentarId}

Input

[Personnummer i header]

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

PersonkommentarId

Guid

 

1

 

Berigtigelseskommentar [FromQuery]

string

Length: 0-1500

1

Kommentarfelt til at beskrive en berigtigelse af en registrering.

Output

Intet andet end status

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

DeleteResponse

DeleteResponseType

 

1

 

-    ServiceReceipt

ServiceReceiptType

 

1

 

-    -    EventDate

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

-    -    MessageIdentifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

Fejlkoder

Gammel Fejlkode

Fejltekst

Beskrivelse

Gammel Fejlkode

Fejltekst

Beskrivelse

4589

Unknown identifier

The submitted Identifier is unknown to the system

4683

The CorrectionComment must contain content

The CorrectionComment must contain content

Tilgængelighed: https://starwiki.atlassian.net/was