Taxonomy.CodeListsService (Version 1, 2023-3)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Kodelisternes værdisæt findes her: /wiki/display/UDV/Taxonomy.CodeLists
Metoder
GetCodeList (GET /v1/CodeLists/{name})
Endpoint action for getting a specific codelist
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
name [Path] | string |
| 1 | Read from the route |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | CodeListDto |
| 1 | REST-objekt. Serialiseres til JSON |
- name | string | MinLength: 1 | 1 | Kodelistenavn |
- items | CodeListItemDtoCollection |
| 1 | Liste af kodelisteværdier |
- - CodeListItemDto | CodeListItemDto |
| 0 - * |
|
- - - id | int32 |
| 1 | Påkrævet unikt Id |
- - - name | string | MinLength: 1 | 1 | Navn på kodelisteværdien |
- - - isActive | boolean |
| 1 | Afgør om kodelisteværdien er aktiv |
- - - description | string | MinLength: 1 | 1 | Beskrivelse af kodelisteværdien |
- - - startDate | date-time |
| 1 | Beskriver hvornår kodelisteværdien er gyldig fra |
- - - endDate | date-time |
| 1 | Beskriver hvornår kodelisteværdien er gyldig til |
Fejlkoder
Ingen fejlkoder
GetCodeLists (GET /v1/CodeLists)
Endpoint action for getting all 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 | Kodelistenavn |
- - items | CodeListItemDtoCollection |
| 1 | Liste af kodelisteværdier |
- - - CodeListItemDto | CodeListItemDto |
| 0 - * |
|
- - - - id | int32 |
| 1 | Påkrævet unikt Id |
- - - - name | string | MinLength: 1 | 1 | Navn på kodelisteværdien |
- - - - isActive | boolean |
| 1 | Afgør om kodelisteværdien er aktiv |
- - - - description | string | MinLength: 1 | 1 | Beskrivelse af kodelisteværdien |
- - - - startDate | date-time |
| 1 | Beskriver hvornår kodelisteværdien er gyldig fra |
- - - - endDate | date-time |
| 1 | Beskriver hvornår kodelisteværdien er gyldig til |
Fejlkoder
Ingen fejlkoder
GetErrorCodeList (GET /v1/CodeLists/ErrorCodeList)
Endpoint action for getting error codelists
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | ErrorCodeDtoCollection |
| 1 |
|
- ErrorCodeDto | ErrorCodeDto |
| 0 - * |
|
- - errorCode | int32 |
| 1 | Fejlkodeværdi |
- - errorMessage | string | MinLength: 1 | 1 | Beskrivende fejlbesked |
- - release | string |
| 0 - 1 | Releaseversion af Taxonomy servicen |
Fejlkoder
Ingen fejlkoder