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

Denne service benyttes til at en sagsbehandler kan registrere sig for gæsteadgang til en borger aht. at kunne se eller opdatere data, der er registreret i DFDG på en borger, også selv om borgeren er fraflyttet. F.eks. af journal-, refusions- og revisionsmæssige årsager. 

Metoder

 

GetGaesteadgange (GET /Gaesteadgang/)

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

Operation

Endpoint

Operation

Endpoint

GET

v1/Gaesteadgang/

Input

[Personnummer i header]

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Gaesteadgange
(PersonCommentCollection)

IEnumerable<GaesteadgangDto>
(PersonCommentTypeCollection)

 

1

En samling af alle gæsteadgange, der er registreret for en given borger

  • Gaesteadgang

(PersonCommentType)

GaesteadgangDto
(PersonCommentType)

 

0 - *

 

  • -    GaesteadgangId

(MessageIdentifier)

guid

 

1

Unik nøgle

  • -    Gaesteadgangskommentar

(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

Sagsbehandler id.

  • -    RegistrerendeMyndighed

(AuthorityStructure)

RegistrerendeMyndighedDto

 

1

Detaljer på myndigheden.

  • -    -    Organisationskode

(AuthorityCode)

string

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

1

Myndighedskode.

  • -    -    OrganisationType

(OrganisationTypeIdentifier)

(OrganisationTypeIdentifierType)

1

Myndighedstype.

  • -    -    AuthorityName

string

 

1

Myndighedsnavn.

 

CreateGaesteadgang (POST /Gaesteadgang/)

Operation

Endpoint

Operation

Endpoint

POST

v1/Gaesteadgang/

Input

[Personnummer i Header]

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateGaesteadgangRequest
(CreatePersonGuestAccessRequest)

CreateGaesteadgangRequestDto

 

1

 

-    Gaesteadgangskommentar
(GuestAccessCommentText)

string

Length: 1-900

1

Begrundelse for behovet for adgang til borger

Output

Task<Guid> hvor guid er gæsteadgangens id.

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateGaesteadgangResponse
(CreatePersonGuestAccessResponse)

CreateGaesteadgangResponseDto
(CreatePersonGuestAccessResponseType)

 

1

 

-    Servicekvittering
(ServiceReceipt)

ServicekvitteringDto
(ServiceReceiptType)

 

1

 

-    -    Registreringstidspunkt
(EventDate)

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

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

60007

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

4922

User is not allowed to access the specified person

User is not allowed to access the specified person

 

CreateGaesteadgang (POST /Gaesteadgang/legacy)

Metoden kan kun benyttes af DFDG Classic, i den overgangsperiode PersonStatusCommentService vedligeholdes for eksternt brug.

Operation

Endpoint

Operation

Endpoint

POST

v1/Gaesteadgang/legacy

Input

[Personnummer i Header]

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateGaesteadgangRequest
(CreatePersonGuestAccessRequest)

CreateGaesteadgangRequestDto

 

1

 

- Gaesteadgangskommentar

(GuestAccessCommentText)

string

Length: 1-900

1

Begrundelse for behovet for adgang til borger

-    AktivOrganisationKode

(AuthorityCode)

string

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

1

Myndighedskode.

-    AktivOrganisationType

(OrganisationTypeIdentifier)

(OrganisationTypeIdentifierType)

1

Myndighedstype.

Output

Task<Guid> hvor guid er gæsteadgangens id.

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateGaesteadgangResponse
(CreatePersonGuestAccessResponse)

CreateGaesteadgangResponseDto
(CreatePersonGuestAccessResponseType)

 

1

 

  • Servicekvittering

(ServiceReceipt)

ServicekvitteringDto
(ServiceReceiptType)

 

1

 

  • -    Registreringstidspunkt

(EventDate)

dateTime

 

1

Tidspunkt for transaktionen eller registrering.

  • -    RegistreringsId

(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

60007

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

4922

User is not allowed to access the specified person

User is not allowed to access the specified person