Borgerindsats.CodeListsService (Version 1, 2024-3)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Kodelisternes værdisæt findes her: /wiki/display/UDV/Borgerindsats.CodeLists
Metoder
- 1 GetCodeList (GET /v1/CodeLists/{name})
- 2 GetCodeLists (GET /v1/CodeLists)
- 3 GetErrorCodeList (GET /v1/CodeLists/ErrorCodeList)
- 4 CreateText (POST /v1/DynamicTexts/create)
- 5 DeleteText (DELETE /v1/DynamicTexts/{externalIdentifier})
- 6 GetText (GET /v1/DynamicTexts/{externalIdentifier})
- 7 GetTexts (GET /v1/DynamicTexts)
- 8 GetAllGroups (GET /v1/DynamicTexts/groups)
- 9 UpdateText (PUT /v1/DynamicTexts/update/{externalIdentifier})
GetCodeList (GET /v1/CodeLists/{name})
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
name [Path] | string |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | CodeListDto |
| 1 |
|
- name | string | MinLength: 1 | 1 |
|
- items | CodeListItemDtoCollection |
| 1 |
|
- - CodeListItemDto | CodeListItemDto |
| 0 - * |
|
- - - id | int32 |
| 1 |
|
- - - name | string | MinLength: 1 | 1 |
|
- - - isActive | boolean |
| 1 |
|
- - - description | string | MinLength: 1 | 1 |
|
- - - startDate | date-time |
| 1 |
|
- - - endDate | date-time |
| 1 |
|
Fejlkoder
Ingen fejlkoder
GetCodeLists (GET /v1/CodeLists)
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | CodeListDtoCollection |
| 1 |
|
- CodeListDto | CodeListDto |
| 0 - * |
|
- - name | string | MinLength: 1 | 1 |
|
- - items | CodeListItemDtoCollection |
| 1 |
|
- - - CodeListItemDto | CodeListItemDto |
| 0 - * |
|
- - - - id | int32 |
| 1 |
|
- - - - name | string | MinLength: 1 | 1 |
|
- - - - isActive | boolean |
| 1 |
|
- - - - description | string | MinLength: 1 | 1 |
|
- - - - startDate | date-time |
| 1 |
|
- - - - endDate | date-time |
| 1 |
|
Fejlkoder
Ingen fejlkoder
GetErrorCodeList (GET /v1/CodeLists/ErrorCodeList)
Returner listen med fejl koder
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | ErrorCodeDtoCollection |
| 1 |
|
- ErrorCodeDto | ErrorCodeDto |
| 0 - * |
|
- - errorCode | int32 |
| 1 |
|
- - errorMessage | string | MinLength: 1 | 1 |
|
- - release | string |
| 0 - 1 |
|
Fejlkoder
Ingen fejlkoder
CreateText (POST /v1/DynamicTexts/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/DynamicTexts/{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
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | ActionResult |
| 1 |
|
Fejlkoder
Ingen fejlkoder
GetText (GET /v1/DynamicTexts/{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/DynamicTexts)
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/DynamicTexts/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/DynamicTexts/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
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | ActionResult |
| 1 |
|
Fejlkoder
Ingen fejlkoder