EksternKommunikation.BeskedtypeService (Version 1, 2023-4)

Siden opdateres automatisk til at afspejle koden.

Metoder

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]	EntityTypeCodeList		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 angivet varighed er negativ, startdato er større end slutdato	Den angivet 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.besked.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	EntityTypeCodeList		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	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	EntityTypeCodeList	1
- strategitype	StrategyTypeCodeList	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	Forekomst	Beskrivelse
response	GetDistributionsstrategiResponseDto	1
- distributionsstrategier	DistributionsstrategiDtoCollection	1	En liste over alle distributionsstrategier
- - DistributionsstrategiDto	DistributionsstrategiDto	0 - *
- - - entitetType	EntityTypeCodeList	1
- - - strategitype	StrategyTypeCodeList	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	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	EntityTypeCodeList	1
- strategitype	StrategyTypeCodeList	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

CreateTilladtAbonnement (POST /v1/Beskedtype/tilladtabonnement)

Denne metode anvendes til at give en organisationstype tilladelse til at abonnere på en bestemt beskedtype.

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	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	CreateTilladtAbonnementRequestDto	1
- entitetType	EntityTypeCodeList	1
- organisationType	OrganisationTypeCodeList	1

Output

Intet output

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
150002	Det angivne beskedtypeId er ikke kendt i systemet	Det angivne beskedtypeId er ikke kendt i systemet
150011	En abonnementstilladelse med det givne beskedid og organisationstype findes allerede i systemet	En abonnementstilladelse med det givne beskedid og organisationstype findes allerede i systemet

DeleteTilladtAbonnement (DELETE /v1/Beskedtype/tilladtabonnement)

Denne metode anvendes til at fjerne en tilladelse for en organisationstype til at abonnere på en bestemt beskedtype.

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	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	DeleteTilladtAbonnementRequestDto	1
- entitetType	EntityTypeCodeList	1
- organisationType	OrganisationTypeCodeList	1

Output

Intet output

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
150002	Det angivne beskedtypeId er ikke kendt i systemet	Det angivne beskedtypeId er ikke kendt i systemet
150012	Abonnementstilladelsen med det givne beskedid og organisationstype findes ikke i systemet	Abonnementstilladelsen med det givne beskedid og organisationstype 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.staronly.read

Input

Element	Type	Detaljer	Forekomst	Beskrivelse

Output

Element	Type	Forekomst
response	GetTilladtAbonnementResponseDto	1
- tilladteAbonnementer	TilladtAbonnementDtoCollection	1
- - TilladtAbonnementDto	TilladtAbonnementDto	0 - *
- - - entitetType	EntityTypeCodeList	1
- - - organisationType	OrganisationTypeCodeList	1

Fejlkoder

Ingen fejlkoder

CreateTilladtSystemAbonnement (POST /v1/Beskedtype/tilladtsystemabonnement)

Denne metode anvendes til at give et system tilladelse til at abonnere på en bestemt beskedtype for en given 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
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	CreateTilladtSystemAbonnementRequestDto		1
- entitetType	EntityTypeCodeList		1
- organisationType	OrganisationTypeCodeList		1
- organisationKode	string	Length: 1-255	1	Myndighedskoden for den myndighed tilladelsen gælder for
- systemIdentifier	uuid		1	Entydig nøgle der identificerer systemet

Output

Intet output

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
150013	Systemabonnementstilladelse for denne beskedtype/myndighed/system kombination findes allerede	Systemabonnementstilladelse for denne beskedtype/myndighed/system kombination findes allerede
150015	Ukendt SystemId	Ukendt SystemId
150002	Det angivne beskedtypeId er ikke kendt i systemet	Det angivne beskedtypeId er ikke kendt i systemet

DeleteTilladtSystemAbonnement (DELETE /v1/Beskedtype/tilladtsystemabonnement)

Denne metode anvendes til at fjerne en tilladelse for et system til at abonnere på en bestemt beskedtype for en given 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
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	DeleteTilladtSystemAbonnementRequestDto		1
- entitetType	EntityTypeCodeList		1
- organisationType	OrganisationTypeCodeList		1
- organisationKode	string	Length: 1-255	1	Myndighedskoden for den myndighed tilladelsen gælder for
- systemIdentifier	uuid		1	Entydig nøgle der identificerer systemet

Output

Intet output

Fejlkoder

Fejlkode	Fejltekst	Beskrivelse
150002	Det angivne beskedtypeId er ikke kendt i systemet	Det angivne beskedtypeId er ikke kendt i systemet
150014	Systemabonnementstilladelse for denne beskedtype/myndighed/system kombination findes ikke	Systemabonnementstilladelse for denne beskedtype/myndighed/system kombination findes ikke
150015	Ukendt SystemId	Ukendt SystemId

GetTilladteSystemAbonnementer (GET /v1/Beskedtype/tilladtsystemabonnement)

Denne metode henter alle tilladte abonnementer for 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.beskedtype.read

Input

Element	Type	Detaljer	Forekomst	Beskrivelse

Output

Element	Type	Detaljer	Forekomst	Beskrivelse
response	GetTilladtSystemAbonnementResponseDto		1
- tilladteSystemAbonnementer	TilladtSystemAbonnementDtoCollection		1
- - TilladtSystemAbonnementDto	TilladtSystemAbonnementDto		0 - *
- - - entitetType	EntityTypeCodeList		1
- - - organisationType	OrganisationTypeCodeList		1
- - - organisationKode	string	Length: 1-255	1	Myndighedskoden for den myndighed tilladelsen gælder for
- - - systemIdentifier	uuid		1	Entydig nøgle der identificerer systemet

Fejlkoder

Ingen fejlkoder

EksternKommunikation.BeskedtypeService (Version 1, 2023-4)

Metoder

UpdateBeskedtype (PUT /v1/Beskedtype/{entitetType})

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetBeskedtyper (GET /v1/Beskedtype)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

CreateDistributionsstrategi (POST /v1/Beskedtype/distributionsstrategi)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetDistributionsstrategier (GET /v1/Beskedtype/distributionsstrategi)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

DeleteDistributionsstrategi (DELETE /v1/Beskedtype/distributionsstrategi)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

CreateTilladtAbonnement (POST /v1/Beskedtype/tilladtabonnement)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

DeleteTilladtAbonnement (DELETE /v1/Beskedtype/tilladtabonnement)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetTilladteAbonnementer (GET /v1/Beskedtype/tilladtabonnement)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

CreateTilladtSystemAbonnement (POST /v1/Beskedtype/tilladtsystemabonnement)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

DeleteTilladtSystemAbonnement (DELETE /v1/Beskedtype/tilladtsystemabonnement)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

GetTilladteSystemAbonnementer (GET /v1/Beskedtype/tilladtsystemabonnement)

Tilladte organisationer

Scope

Input

Output

Fejlkoder

Tilgængelighed: https://starwiki.atlassian.net/was