Borgerkommunikation.TilkendegivelseService (Version 1, 2024-1)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
GetTilkendegivelse (GET /v1/Tilkendegivelse)
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.tilkendegivelse.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 |
startTidspunkt [Query] | date-time |
| 0 - 1 | Tidspunkt for første tilkendegivelse der ønskes udtrukket |
slutTidspunkt [Query] | date-time |
| 0 - 1 | Tidspunkt for sidste tilkendegivelse der ønskes udtrukket |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetTilkendegivelseResponseDto |
| 1 |
|
- tilkendegivelser | TilkendegivelseDtoCollection |
| 1 |
|
- - TilkendegivelseDto | TilkendegivelseDto |
| 0 - * |
|
- - - tilkendegivelseIdentifier | uuid |
| 1 |
|
- - - startTidspunkt | date-time |
| 1 |
|
- - - slutTidspunkt | date-time |
| 0 - 1 |
|
- - - tilkendegivelseType | int32 |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
60006 | Unknown cpr | Unknown cpr |
CreateTilkendegivelse (POST /v1/Tilkendegivelse)
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.tilkendegivelse.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 | CreateTilkendegivelseRequestDto |
| 1 |
|
- tilkendegivelseIdentifier | uuid |
| 0 - 1 | Unik identifier for tilkendegivelsen. Hvis den ikke er angivet, tildeles den af DFDG. |
- tilkendegivelseType | int32 |
| 1 | Angivelse af hvilken tilkendegivelse borger har givet, fx samtykke eller læsningskvittering |
- startTidspunkt | date-time |
| 1 | Tidspunkt for tilkendegivelsen |
- slutTidspunkt | date-time |
| 0 - 1 | Tidspunkt for tilkendegivelsens afslutning. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
60006 | Unknown cpr | Unknown cpr |
60007 | The person with specified cpr is dead | The person with specified cpr is dead |
60005 | Slutdato må ikke være før startdato | Slutdato må ikke være før startdato |