Borgerkommunikation.GaesteadgangService (Version 1, 2023-4)
Siden opdateres automatisk til at afspejle koden.
Metoder
GetGaesteadgange (GET /v1/Gaesteadgang)
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 |
---|---|---|---|---|---|---|---|---|
A-kasse | X |
|
|
|
|
|
|
|
JobCenter | X |
|
|
| X |
|
|
|
Kommune | X |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerkommunikation.gaesteadgang.read
Input
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 |
---|---|---|---|---|
response | GaesteadgangDtoCollection |
| 1 |
|
- GaesteadgangDto | GaesteadgangDto |
| 0 - * |
|
- - gaesteadgangId | uuid |
| 1 | Unik nøgle |
- - gaesteadgangskommentar | string | Length: 1-1000 | 1 | Kommentartekst |
- - dfdgRegisteringstidspunkt | date-time |
| 1 | Hændelsesdato for registrering |
- - sagsbehandler | SagsbehandlerDto |
| 1 |
|
- - - brugerFuldtNavn | string | Length: 1-140 | 0 - 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
- - - brugerId | string | Length: 1-64 | 1 | Sagsbehandlerens RID fra medarbejder OCES certifikatet. |
- - registrerendeMyndighed | RegistrerendeMyndighedDto |
| 1 |
|
- - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Myndighedskode. |
- - - organisationType |
| 1 |
|
Fejlkoder
Ingen fejlkoder
CreateGaesteadgang (POST /v1/Gaesteadgang)
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 |
---|---|---|---|---|---|---|---|---|
A-kasse | X |
|
|
|
|
|
|
|
JobCenter | X |
|
|
| X |
|
|
|
Kommune | X |
|
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerkommunikation.gaesteadgang.write
Input
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 | CreateGaesteadgangRequestDto |
| 1 |
|
- gaesteadgangskommentar | string | Length: 1-900 | 1 | Begrundelse for behovet for adgang til borger |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
4933 | Kommentaren må ikke indeholde HTML | Kommentaren må ikke indeholde HTML |
CreateGaesteadgangLegacy (POST /v1/Gaesteadgang/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 |
---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
borgerkommunikation.gaesteadgang.staronly.write
Input
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 | CreateGaesteadgangLegacyRequestDto |
| 1 |
|
- gaesteadgangskommentar | string | Length: 1-900 | 1 | Begrundelse for behovet for adgang til borger |
- aktivOrganisationKode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Myndighedskode. |
- aktivOrganisationType |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
4933 | Kommentaren må ikke indeholde HTML | Kommentaren må ikke indeholde HTML |