EksternKommunikation.AbonnementService (Version 2, 2023-4)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateAbonnerendeSystem (POST /v2/Abonnement/system)
- 2 GetAbonnerendeSystemer (GET /v2/Abonnement/system)
- 3 UpdateAbonnerendeSystem (PUT /v2/Abonnement/system/{systemIdentifier})
- 4 GetAbonnerendeSystem (GET /v2/Abonnement/system/{systemIdentifier})
- 5 DeleteAbonnerendeSystem (DELETE /v2/Abonnement/system/{systemIdentifier})
- 6 GetAbonnementer (GET /v2/Abonnement/{subscriberSystemIdentifier})
- 7 SyncAbonnementer (PUT /v2/Abonnement/action/syncabonnementer)
CreateAbonnerendeSystem (POST /v2/Abonnement/system)
Denne metode opretter et abonnerende system
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
eksternkommunikation.abonnement.staronly.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 | CreateAbonnerendeSystemRequestDto |
| 1 |
|
- navn | string | Length: 1-100 | 1 | Navnet på det abonnerende system |
- baseUrl | string | Length: 1-255 | 1 | Base URL for endpoints som modtager beskeder, der er tegnet abonnement på |
- emailadresse | string | MaxLength: 255 | 0 - 1 | Emailadresse til kontakt, f.eks. ifm. fejlsøgning |
- ejersystemType |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
150007 | Et system med samme navn findes allerede i systemet | Et system med samme navn findes allerede i systemet |
150008 | Base url er ikke en gyldig url | Base url er ikke en gyldig url |
GetAbonnerendeSystemer (GET /v2/Abonnement/system)
Denne metode henter alle eksisterende abonnerende systemer
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.abonnement.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetAbonnerendeSystemResponseDto |
| 1 |
|
- systemer | AbonnerendeSystemDtoCollection |
| 1 |
|
- - AbonnerendeSystemDto | AbonnerendeSystemDto |
| 0 - * |
|
- - - navn | string | Length: 1-100 | 1 | Navnet på det abonnerende system |
- - - baseUrl | string | Length: 1-255 | 1 | Base URL for endpoints som modtager beskeder, der er tegnet abonnement på |
- - - emailadresse | string | MaxLength: 255 | 0 - 1 | Emailadresse til kontakt, f.eks. ifm. fejlsøgning |
- - - ejersystemType |
| 1 |
| |
- - - systemIdentifier | uuid |
| 1 | Entydig nøgle der identificerer systemet |
Fejlkoder
Ingen fejlkoder
UpdateAbonnerendeSystem (PUT /v2/Abonnement/system/{systemIdentifier})
Denne metode opdaterer et abonnerende system
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
eksternkommunikation.abonnement.staronly.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
systemIdentifier [Path] | uuid |
| 1 |
|
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 | UpdateAbonnerendeSystemRequestDto |
| 1 |
|
- navn | string | Length: 1-100 | 1 | Navnet på det abonnerende system |
- baseUrl | string | Length: 1-255 | 1 | Base URL for endpoints som modtager beskeder, der er tegnet abonnement på |
- emailadresse | string | MaxLength: 255 | 0 - 1 | Emailadresse til kontakt, f.eks. ifm. fejlsøgning |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
150017 | Elementet findes ikke | Elementet findes ikke |
150007 | Et system med samme navn findes allerede i systemet | Et system med samme navn findes allerede i systemet |
150008 | Base url er ikke en gyldig url | Base url er ikke en gyldig url |
GetAbonnerendeSystem (GET /v2/Abonnement/system/{systemIdentifier})
Denne metode henter et eksisterende abonnerende system
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.abonnement.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
systemIdentifier [Path] | uuid |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | AbonnerendeSystemDto |
| 1 |
|
- navn | string | Length: 1-100 | 1 | Navnet på det abonnerende system |
- baseUrl | string | Length: 1-255 | 1 | Base URL for endpoints som modtager beskeder, der er tegnet abonnement på |
- emailadresse | string | MaxLength: 255 | 0 - 1 | Emailadresse til kontakt, f.eks. ifm. fejlsøgning |
- ejersystemType |
| 1 |
| |
- systemIdentifier | uuid |
| 1 | Entydig nøgle der identificerer systemet |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
150015 | Ukendt SystemId | Ukendt SystemId |
DeleteAbonnerendeSystem (DELETE /v2/Abonnement/system/{systemIdentifier})
Denne metode sletter et eksisterende abonnerende system
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
eksternkommunikation.abonnement.staronly.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
systemIdentifier [Path] | uuid |
| 1 |
|
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 |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
150017 | Elementet findes ikke | Elementet findes ikke |
GetAbonnementer (GET /v2/Abonnement/{subscriberSystemIdentifier})
Denne metode henter abonnementer for et abonnerende system, eller for alle abonnerende systemer, hvis parameteren subscriberSystemIdentifier udelades.
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.abonnement.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
subscriberSystemIdentifier [Path] | uuid |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetAbonnementResponseDto |
| 1 |
|
- abonnementer | AbonnerendeSystemAbonnementDtoCollection |
| 1 | En liste af kalders nuværende abonnementer |
- - AbonnerendeSystemAbonnementDto | AbonnerendeSystemAbonnementDto |
| 0 - * |
|
- - - systemIdentifier | uuid |
| 1 | Entydig nøgle der identificerer systemet |
- - - navn | string | Length: 1-100 | 1 | Navnet på det abonnerende system |
- - - abonnementer | AbonnementDtoBaseCollection |
| 1 | Liste af abonnementer |
- - - - AbonnementDtoBase | AbonnementDtoBase |
| 0 - * |
|
- - - - - organisationstype |
| 1 |
| |
- - - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Organisationskode som abonnementet er knyttet til |
- - - - - entitetType | int32 |
| 1 | Kodeliste Id på typen af besked der abonneres på |
- - - - - webhookUrl | string | Length: 1-500 | 1 | Angiver sidste del af det endpoint som abonnerende beskeder sendes til |
- - - - - startDato | date-time |
| 0 - 1 | Abonnementets startdato |
- - - - - slutDato | date-time |
| 0 - 1 | Abonnementets evt. slutdato |
- - - - - abonnementIdentifier | uuid |
| 1 | Entydig nøgle der identificerer abonnementet |
Fejlkoder
Ingen fejlkoder
SyncAbonnementer (PUT /v2/Abonnement/action/syncabonnementer)
Metode til at bulk oprette, rette og nedlægge abonnementer.
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.abonnement.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 | SyncAbonnementRequestDto |
| 1 |
|
- systemIdentifier | uuid |
| 1 | Det system som opdateringen gælder for |
- abonnementer | SyncAbonnementDtoCollection |
| 1 | List af abonnementer for det angivet system |
- - SyncAbonnementDto | SyncAbonnementDto |
| 0 - * |
|
- - - organisationstype |
| 1 |
| |
- - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} | 1 | Organisationskode som abonnementet er knyttet til |
- - - entitetType | int32 |
| 1 | Kodeliste Id på typen af besked der abonneres på |
- - - webhookUrl | string | Length: 1-500 | 1 | Angiver sidste del af det endpoint som abonnerende beskeder sendes til |
- - - startDato | date-time |
| 0 - 1 | Abonnementets startdato |
- - - slutDato | date-time |
| 0 - 1 | Abonnementets evt. slutdato |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1003 | Den angivne varighed er negativ, startdato er større end slutdato | Den angivne varighed er negativ, startdato er større end slutdato |
150000 | Slutdato skal være dagsdato eller i fremtiden | Slutdato skal være dagsdato eller i fremtiden |
150003 | Abonnement på beskedtypen er ikke tilladt | Abonnement på beskedtypen er ikke tilladt |
150004 | Webhook url er ikke en gyldig url | Webhook url er ikke en gyldig url |
150015 | Ukendt SystemId | Ukendt SystemId |
150018 | En eller flere fejl ifm abonnementssynkronisering | En eller flere fejl ifm abonnementssynkronisering |