EksternKommunikation.BeskedtypeService (Version 1, 2023-4)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 UpdateBeskedtype (PUT /v1/Beskedtype/{entitetType})
- 2 GetBeskedtyper (GET /v1/Beskedtype)
- 3 CreateDistributionsstrategi (POST /v1/Beskedtype/distributionsstrategi)
- 4 GetDistributionsstrategier (GET /v1/Beskedtype/distributionsstrategi)
- 5 DeleteDistributionsstrategi (DELETE /v1/Beskedtype/distributionsstrategi)
- 6 GetTilladteAbonnementer (GET /v1/Beskedtype/tilladtabonnement)
UpdateBeskedtype (PUT /v1/Beskedtype/{entitetType})
Denne metode opdater en beskedtype til webservicebesked
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.beskedtype.staronly.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
entitetType [Path] |
| 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 | UpdateBeskedtypeRequestDto |
| 1 |
|
- navn | string | Length: 1-100 | 1 | Navn på beskedtypen |
- beskrivelse | string | MaxLength: 250 | 0 - 1 | Navn på beskedtypen |
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 |
150002 | Det angivne beskedtypeId er ikke kendt i systemet | Det angivne beskedtypeId er ikke kendt i systemet |
GetBeskedtyper (GET /v1/Beskedtype)
Denne metode henter alle beskedtyper
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.beskedtype.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetBeskedtypeResponseDto |
| 1 |
|
- beskedtyper | BeskedtypeDtoCollection |
| 1 |
|
- - BeskedtypeDto | BeskedtypeDto |
| 0 - * |
|
- - - navn | string | Length: 1-100 | 1 | Navn på beskedtypen |
- - - beskrivelse | string | MaxLength: 250 | 0 - 1 | Navn på beskedtypen |
- - - entitetType |
| 1 |
|
Fejlkoder
Ingen fejlkoder
CreateDistributionsstrategi (POST /v1/Beskedtype/distributionsstrategi)
Denne metode opretter en distributionsstrategi til webservicebeskeder. En distributionsstrategi knytter en eller flere strategier til en beskedtype så der kan styres hvem der må og efter hvilke regler de må lave abonnementer. Beskedtypen er en forudsætning for det kan laves regler og abonnement.
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.beskedtype.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 | CreateDistributionsstrategiRequestDto |
| 1 |
|
- entitetType |
| 1 |
| |
- strategitype |
| 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
150009 | En distributionsstrategi med det givne beskedid og strategitype findes allerede i systemet | En distributionsstrategi med det givne beskedid og strategitype findes allerede i systemet |
GetDistributionsstrategier (GET /v1/Beskedtype/distributionsstrategi)
Denne metode henter alle distributionsstrategier.
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.beskedtype.staronly.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetDistributionsstrategiResponseDto |
| 1 |
|
- distributionsstrategier | DistributionsstrategiDtoCollection |
| 1 | En liste over alle distributionsstrategier |
- - DistributionsstrategiDto | DistributionsstrategiDto |
| 0 - * |
|
- - - entitetType |
| 1 |
| |
- - - strategitype |
| 1 |
|
Fejlkoder
Ingen fejlkoder
DeleteDistributionsstrategi (DELETE /v1/Beskedtype/distributionsstrategi)
Denne metode sletter en distributionsstrategi.
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.beskedtype.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 | DeleteDistributionsstrategiRequestDto |
| 1 |
|
- entitetType |
| 1 |
| |
- strategitype |
| 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
150010 | Distributionsstrategien med det givne beskedid og strategitype findes ikke i systemet | Distributionsstrategien med det givne beskedid og strategitype findes ikke i systemet |
GetTilladteAbonnementer (GET /v1/Beskedtype/tilladtabonnement)
Denne metode henter alle tilladte abonnementer for organisationstyper.
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.beskedtype.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetTilladtAbonnementResponseDto |
| 1 |
|
- tilladteAbonnementer | TilladtAbonnementDtoCollection |
| 1 |
|
- - TilladtAbonnementDto | TilladtAbonnementDto |
| 0 - * |
|
- - - entitetType |
| 1 |
| |
- - - organisationType |
| 1 |
|
Fejlkoder
Ingen fejlkoder