Virksomhedsindsats.EmailskabelonService (Version 1, 2024-1)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateEmailskabelon (POST /v1/Emailskabelon)

Opretter en e-mailskabelon.

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

 

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

virksomhedsindsats.emailskabelon.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

CreateEmailskabelonRequestDto

 

1

 

-    emailskabelon

EmailskabelonDto

 

1

E-mailskabelon.

-    -    overskrift

string

Length: 1-250

1

Overskrift i e-mailskabelon.

-    -    broedtekst

string

Length: 1-16000

1

Brødtekst i e-mailskabelon.

-    -    prioritet

int32

 

1

Prioritet, som anvendes til sortering af skabeloner af samme type.

-    -    type

EmailskabelonTypeCodeList

 

1

 

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

2002

Invalid CodeList value

Invalid CodeList value

GetEmailskabeloner (GET /v1/Emailskabelon)

Henter samtlige e-mailskabeloner.

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

 

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

virksomhedsindsats.emailskabelon.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetEmailskabelonerResponseDto

 

1

 

-    emailskabeloner

EmailskabelonGetDtoCollection

 

1

Samtlige e-mailskabeloner.

-    -    EmailskabelonGetDto

EmailskabelonGetDto

 

0 - *

 

-    -    -    overskrift

string

Length: 1-250

1

Overskrift i e-mailskabelon.

-    -    -    broedtekst

string

Length: 1-16000

1

Brødtekst i e-mailskabelon.

-    -    -    prioritet

int32

 

1

Prioritet, som anvendes til sortering af skabeloner af samme type.

-    -    -    type

EmailskabelonTypeCodeList

 

1

 

-    -    -    id

uuid

 

1

Id for e-mailskabelonen.

-    -    -    oprettetTidspunkt

date-time

 

1

Tidspunkt for oprettelse.

-    -    -    opdateretTidspunkt

date-time

 

1

Tidspunkt for seneste opdatering.

Fejlkoder

Ingen fejlkoder

GetEmailskabelon (GET /v1/Emailskabelon/{id})

Finder en e-mailskabelon.

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

 

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

virksomhedsindsats.emailskabelon.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

uuid

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetEmailskabelonResponseDto

 

1

 

-    emailskabelon

EmailskabelonGetDto

 

1

 

-    -    overskrift

string

Length: 1-250

1

Overskrift i e-mailskabelon.

-    -    broedtekst

string

Length: 1-16000

1

Brødtekst i e-mailskabelon.

-    -    prioritet

int32

 

1

Prioritet, som anvendes til sortering af skabeloner af samme type.

-    -    type

EmailskabelonTypeCodeList

 

1

 

-    -    id

uuid

 

1

Id for e-mailskabelonen.

-    -    oprettetTidspunkt

date-time

 

1

Tidspunkt for oprettelse.

-    -    opdateretTidspunkt

date-time

 

1

Tidspunkt for seneste opdatering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

120900

E-mailskabelonen blev ikke fundet.

E-mailskabelonen blev ikke fundet.

UpdateEmailskabelon (PUT /v1/Emailskabelon/{id})

Opdaterer en e-mailskabelon.

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

 

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

virksomhedsindsats.emailskabelon.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

id [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

UpdateEmailskabelonRequestDto

 

1

 

-    emailskabelon

EmailskabelonDto

 

1

E-mailskabelon.

-    -    overskrift

string

Length: 1-250

1

Overskrift i e-mailskabelon.

-    -    broedtekst

string

Length: 1-16000

1

Brødtekst i e-mailskabelon.

-    -    prioritet

int32

 

1

Prioritet, som anvendes til sortering af skabeloner af samme type.

-    -    type

EmailskabelonTypeCodeList

 

1

 

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

120900

E-mailskabelonen blev ikke fundet.

E-mailskabelonen blev ikke fundet.

2002

Invalid CodeList value

Invalid CodeList value

DeleteEmailskabelon (DELETE /v1/Emailskabelon/{id})

Sletter en e-mailskabelon.

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

 

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

virksomhedsindsats.emailskabelon.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

id [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

Fejlkode

Fejltekst

Beskrivelse

120900

E-mailskabelonen blev ikke fundet.

E-mailskabelonen blev ikke fundet.