Virksomhedsindsats.EmailskabelonService (Version 1 [UDV], 2024-1)
- Rolf Marcher Arndt
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateEmailskabelon (POST /v1/Emailskabelon)
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 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 | CreateEmailskabelonRequestDto |
| 1 |
|
- skabelon | EmailskabelonDto |
| 1 |
|
- - emailTitel | string | Length: 1-100 | 1 | Titel i skabelonens email |
- - emailTekst | string | MinLength: 1 | 1 | Brødtekst i skabelonens email |
- - type |
| 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
2002 | Invalid CodeList value | Invalid CodeList value |
GetEmailskabelon (GET /v1/Emailskabelon)
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetEmailskabelonerResponseDto |
| 1 |
|
- skabeloner | EmailskabelonGetDtoCollection |
| 1 | Alle email skabeloner |
- - EmailskabelonGetDto | EmailskabelonGetDto |
| 0 - * |
|
- - - emailTitel | string | Length: 1-100 | 1 | Titel i skabelonens email |
- - - emailTekst | string | MinLength: 1 | 1 | Brødtekst i skabelonens email |
- - - type |
| 1 |
| |
- - - id | int32 |
| 1 | Id for skabelonen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
XxXxXx | Emailskabelon kunne ikke findes | Emailskabelon kunne ikke findes |
UpdateEmailskabelon (PUT /v1/Emailskabelon/{id})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | int32 |
| 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 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 | UpdateEmailskabelonRequestDto |
| 1 |
|
- skabelon | EmailskabelonDto |
| 1 |
|
- - emailTitel | string | Length: 1-100 | 1 | Titel i skabelonens email |
- - emailTekst | string | MinLength: 1 | 1 | Brødtekst i skabelonens email |
- - type |
| 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
2002 | Invalid CodeList value | Invalid CodeList value |
XxXxXx | Emailskabelon kunne ikke findes | Emailskabelon kunne ikke findes |
DeleteEmailskabelon (DELETE /v1/Emailskabelon/{id})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | int32 |
| 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 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 |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
XxXxXx | Emailskabelon kunne ikke findes | Emailskabelon kunne ikke findes |