Metoder
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 | CreateHenvisningRequestDto | 1 | ||
- tilkendegivelseIdentifier | uuid | 0-1 | Unik identifier for tilkendegivelsen. Hvis den ikke er angivet, tildeles den af DFDG. | |
- tilkendegivelsestype | 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 |
|---|---|---|
60005 | Slutdato må ikke være før startdato | Slutdato må ikke være før startdato |
60006 | Unknown cpr | Unknown cpr |
60007 | The person with specified cpr is dead | The person with specified cpr is dead |
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.borger.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 | date time | 0-1 | Tidspunkt for første tilkendegivelse der ønskes udtrukket | |
sluttidspunkt | date time | 0-1 | Tidspunkt for sidste tilkendegivelse der ønskes udtrukket |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetTilkendegivelseResponseDto | 1 | ||
- tilkendegivelser | TilkendegivelserDtoCollection | 1 | Tilkendegivelser | |
- - tilkendegivelseDto | HenvisningDto | 0 - * | ||
- - - tilkendegivelseId | uuid | 1 | Unik identifikation af tilkendegivelse | |
- - - tilkendegivelsestype | 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. |
Fejlkoder
Ingen