EksternKommunikation.BeskedService (Version 1, 2024-4)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
GetBeskeder (GET /v1/Besked)
Denne metode henter alle afsendte beskeder for den kaldende myndighed.
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 |
|---|---|---|---|---|---|---|---|---|
Klientsystem |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
eksternkommunikation.besked.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 |
|
slutTidspunkt [Query] | date-time |
| 0 - 1 |
|
entitetstype [Query] |
| 0 - 1 |
| |
sidenummer [Query] | int32 |
| 0 - 1 |
|
sideStoerrelse [Query] | int32 |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetBeskederResponseDto |
| 1 |
|
- afsendteBeskeder | AfsendtBeskedDtoCollection |
| 1 | Samling af afsendte beskeder |
- - AfsendtBeskedDto | AfsendtBeskedDto |
| 0 - * |
|
- - - id | int32 |
| 0 - 1 | Identifikation af den afsendte besked. |
- - - externalIdentifier | uuid |
| 1 | Unik identifier. |
- - - beskedTilModtager | BeskedTilModtagerDto |
| 1 |
|
- - - - id | int32 |
| 1 | Besked til modtager identifikation. |
- - - - besked | BeskedDto |
| 1 |
|
- - - - - id | int32 |
| 1 | Identifikation af Besked |
- - - - - entitetType |
| 1 |
| |
- - - - - payloadBody | string |
| 0 - 1 | Beskedens PayloadBody |
- - - - - identifikation | string | MinLength: 1 | 1 | Identifikation af event som forårsagede at beskeden blev skabt. |
- - - - payloadHeader | string | MinLength: 1 | 1 | Metadata om modtageren. |
- - - webhookUrl | uri |
| 1 | Webhook Url. |
- - - afsendelsestidspunkt | date-time |
| 1 | Afsendelsestidspunkt for den afsendte besked. |
- - - httpResponseCode | int32 |
| 0 - 1 | Http responskode. |
- - - httpResponseBody | string |
| 0 - 1 | Http responsebody. |
- - - exception | string |
| 0 - 1 | Exeception. |
Fejlkoder
Ingen fejlkoder
GenafsendWebservicebeskeder (POST /v1/Besked/action/genafsendwebservicebeskeder)
Denne metode genafsender afsendte beskeder ud fra nogle input parametre
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 |
|---|---|---|---|---|---|---|---|---|
Klientsystem |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
eksternkommunikation.besked.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 | GenafsendWebservicebeskederRequestDto |
| 1 |
|
- entitetType |
| 0 - 1 |
| |
- starttidspunkt | date-time |
| 1 | Starttidspunktet for hvornår at servicen opsamler beskeder til genafsendelse |
- sluttidspunkt | date-time |
| 0 - 1 | Sluttidspunktet for hvornår at servicen opsamler beskeder til genafsendelse |
- organisationType |
| 1 |
| |
- organisationKode | string | MinLength: 1 | 1 | Organisationskoden for den modtagende myndighed |
- systemIdentifier | uuid |
| 1 | Det modtagende system |
Output
Intet output
Fejlkoder
Ingen fejlkoder
GetBlokeredeBeskeder (GET /v1/Besked/blokeredebeskeder/{abonnerendeSystemIdentifier})
Denne metode henter alle blokerede beskeder for den kaldende myndighed.
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 |
|---|---|---|---|---|---|---|---|---|
Klientsystem |
| X |
|
|
|
|
|
|
STAR | X |
|
|
|
|
|
|
|
Scope
eksternkommunikation.besked.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
abonnerendeSystemIdentifier [Path] | uuid |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetBlokeredeBeskederResponseDto |
| 1 | Indeholder en samling af blokerede beskeder |
- blokeredeEntiteter | BlokeretEntitetDtoCollection |
| 1 | Samling af blokerede beskeder |
- - BlokeretEntitetDto | BlokeretEntitetDto |
| 0 - * |
|
- - - identifikation | string | MinLength: 1 | 1 | Identifikation af kollektionen af blokerede beskeder |
- - - systemIdentifier | uuid |
| 1 | Identifikation af systemet med blokerede beskeder |
- - - systemNavn | string | MinLength: 1 | 1 | Navn på systemet med blokerede beskeder |
- - - blokeringsdato | date-time |
| 1 | Dato for blokering af beskeder |
- - - blokeredeBeskeder | BlokeretBeskedDtoCollection |
| 1 | Liste af blokerede beskeder |
- - - - BlokeretBeskedDto | BlokeretBeskedDto |
| 0 - * |
|
- - - - - beskedType |
| 0 - 1 |
| |
- - - - - senesteAfsendelse | date-time |
| 0 - 1 | Hvonår beskeden sidst blev afsendt |
- - - - - status | int32 |
| 0 - 1 | Http status koden for beskeden |
- - - - - organisationstype |
| 0 - 1 |
| |
- - - - - organisationskode | string | MinLength: 1 | 1 | Organisationskode |
- - - - - modtager | string | MinLength: 1 | 1 | Modtager |
Fejlkoder
Ingen fejlkoder