Virksomhedsindsats.DynamicTextService (Version 1, 2024-4)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateText (POST /v1/DynamicText/create)
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
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 | CreateDynamicTextDto |
| 1 |
|
- text | string | MinLength: 1 | 1 |
|
- displayText | string | MinLength: 1 | 1 |
|
- groupExternalIdentifier | uuid |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Ingen fejlkoder
DeleteText (DELETE /v1/DynamicText/{externalIdentifier})
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
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
externalIdentifier [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
Ingen fejlkoder
GetText (GET /v1/DynamicText/{externalIdentifier})
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
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
externalIdentifier [Path] | uuid |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetDynamicTextDto |
| 1 |
|
- externalIdentifier | uuid |
| 1 |
|
- text | string | MinLength: 1 | 1 |
|
- displayText | string | MinLength: 1 | 1 |
|
- group | GetDynamicTextGroupDto |
| 0 - 1 |
|
- - externalIdentifier | uuid |
| 1 |
|
- - name | string | MinLength: 1 | 1 |
|
Fejlkoder
Ingen fejlkoder
GetTexts (GET /v1/DynamicText)
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
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
externalGroupIdentifier [Query] | uuid |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetDynamicTextDtoCollection |
| 1 |
|
- GetDynamicTextDto | GetDynamicTextDto |
| 0 - * |
|
- - externalIdentifier | uuid |
| 1 |
|
- - text | string | MinLength: 1 | 1 |
|
- - displayText | string | MinLength: 1 | 1 |
|
- - group | GetDynamicTextGroupDto |
| 0 - 1 |
|
- - - externalIdentifier | uuid |
| 1 |
|
- - - name | string | MinLength: 1 | 1 |
|
Fejlkoder
Ingen fejlkoder
GetAllGroups (GET /v1/DynamicText/groups)
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
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetDynamicTextGroupDtoCollection |
| 1 |
|
- GetDynamicTextGroupDto | GetDynamicTextGroupDto |
| 0 - * |
|
- - externalIdentifier | uuid |
| 1 |
|
- - name | string | MinLength: 1 | 1 |
|
Fejlkoder
Ingen fejlkoder
UpdateText (PUT /v1/DynamicText/update/{externalIdentifier})
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
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
externalIdentifier [Path] | string |
| 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 | UpdateDynamicTextDto |
| 1 |
|
- externalIdentifier | uuid |
| 1 |
|
- text | string | MinLength: 1 | 1 |
|
- displayText | string | MinLength: 1 | 1 |
|
- groupExternalIdentifier | uuid |
| 0 - 1 |
|
Output
Intet output
Fejlkoder
Ingen fejlkoder