Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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

GetGaestadgange (GET /gaestadgang/)

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

Operation

Endpoint

GET

v1/gaestadgang/

Input

[Personnummer i header]

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Gaestadgange
(PersonCommentCollection)

IEnumerable<GaestadgangDto>
(PersonCommentTypeCollection)

 

1

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

  • Gaestadgang

(PersonCommentType)

GaestadgangDto
(PersonCommentType)

 

0 - *

 

  • -    GaestadgangId

(MessageIdentifier)

guid

1

Unik nøgle

  • -    Gaestadgangskommentar

(CommentText)

string

Length: 1-1000

1

Kommentartekst

  • -    Registreringstidspunkt

(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 RID fra medarbejder OCES certifikatet.

  • -    RegistrerendeMyndighed

(AuthorityStructure)

RegistrerendeMyndighedDto

 

1

Detaljer på myndigheden.

  • -    -    Organisationskode

(AuthorityCode)

string

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

1

Myndighedskode.

  • -    -    OrganisationType

(OrganisationTypeIdentifier)

OrganisationTypeIdentifier

(OrganisationTypeIdentifierType)

1

Myndighedsnavn.

  • -    -    AuthorityName

string

 

1

Myndighedsnavn.

GetGaestadgang (GET /gaestadgang/{gaestadgangId})

Denne metode benyttes til at hente en specifik gaestadgang, for en given borger.

Operation

Endpoint

GET

v1/gaestadgang/{gaestadgangId}

Input

[Personnummer i header]

Element

Type

Detaljer

Forekomst

Beskrivelse

GaestadgangId

Guid

1

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GaestadgangId

(MessageIdentifier)

guid

1

Unik nøgle

  • Gaestadgangskommentar

(CommentText)

string

Length: 1-1000

1

Kommentartekst

  • Registreringstidspunkt

(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 RID fra medarbejder OCES certifikatet.

  • RegistrerendeMyndighed

(AuthorityStructure)

RegistrerendeMyndighedDto

 

1

Detaljer på myndigheden.

  • -    Organisationskode

(AuthorityCode)

string

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

1

Myndighedskode.

  • -    OrganisationType

(OrganisationTypeIdentifier)

OrganisationTypeIdentifier

(OrganisationTypeIdentifierType)

1

Myndighedsnavn.

  • -    AuthorityName

string

 

1

Myndighedsnavn.

GetHistoriskeGaestadgange (GET /gaestadgang/historik)

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

Operation

Endpoint

GET

v1/gaestadgang/historik

Input

[Personnummer i header]

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GaestadgangshistorikResponse

GaestadgangshistorikResponseDto

  • GaestadgangshistorikSamling

(CommentHistoryCollection)

IEnumerable<GaestadgangshistorikDto>
(CommentTypeCollection)

 

0 - 1

Liste af historiske gaestadgange.

  • -    GaestadgangId

(CommentIdentifier)

guid

1

Identifier for gaestadgang

  • - Gaestadgangskommentar

(CommentText)

string

Length: 1-1000

1

Gaestadgangskommentartekst

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

GetPersonkommentarhistorik (GET /gaestadgang/{gaestadgangId}/historik)

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

Operation

Endpoint

GET

v1/gaestadgang/{gaestadgangId}/historik

Input

[Personnummer i header]

Element

Type

Detaljer

Forekomst

Beskrivelse

PersonkommentarId

Guid

1

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GaestadgangshistorikResponse

GaestadgangshistorikResponseDto

  • GaestadgangshistorikSamling

(CommentHistoryCollection)

IEnumerable<GaestadgangshistorikDto>
(CommentTypeCollection)

 

0 - 1

Liste af historiske gaestadgange.

  • -    GaestadgangId

(CommentIdentifier)

guid

1

Identifier for gaestadgang

  • - Gaestadgangskommentar

(CommentText)

string

Length: 1-1000

1

Gaestadgangskommentartekst

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

CreateGaestadgang (POST /gaestadgang/)

Operation

Endpoint

POST

v1/Gaestadgang/

Input

[Personnummer i Header]

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateGaestadgangRequest
(CreatePersonGuestAccessRequest)

CreateGaestadgangRequestDto

1

-    Gaestadgangskommentar
(GuestAccessCommentText)

string

Length: 1-900

1

Begrundelse for behovet for adgang til borger

Output

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

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateGaestadgangResponse
(CreatePersonGuestAccessResponse)

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

Nye fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Findes allerede i BorgerKommunikation med en anden kode

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

4922

User is not allowed to access the specified person

User is not allowed to access the specified person

  • No labels

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