Komposit.CodeListsService (Version 1, 2024-1)

Siden opdateres automatisk til at afspejle koden.

Kodelisternes værdisæt findes her: /wiki/display/UDV/Komposit.CodeLists

Metoder

GetCodeList (GET /v1/CodeLists/{name})

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

name [Path]

string

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

CodeListDto

 

1

 

-    name

string

MinLength: 1

1

Navnet på kodelisten.

-    items

CodeListItemDtoCollection

 

1

De tilkoblede kodeliste genstande.

-    -    CodeListItemDto

CodeListItemDto

 

0 - *

 

-    -    -    id

int32

 

1

Id for kodeliste genstanden.

-    -    -    name

string

MinLength: 1

1

Navnet på kodeliste genstanden.

-    -    -    isActive

boolean

 

1

Om kodeliste genstanden er aktiv.

-    -    -    description

string

MinLength: 1

1

Beskrivelse for kodeliste genstanden.

-    -    -    startDate

date-time

 

1

Start dato for kodeliste genstanden.

-    -    -    endDate

date-time

 

1

Slut dato for kodeliste genstanden.

Fejlkoder

Ingen fejlkoder

GetCodeLists (GET /v1/CodeLists)

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

CodeListDtoCollection

 

1

 

-    CodeListDto

CodeListDto

 

0 - *

 

-    -    name

string

MinLength: 1

1

Navnet på kodelisten.

-    -    items

CodeListItemDtoCollection

 

1

De tilkoblede kodeliste genstande.

-    -    -    CodeListItemDto

CodeListItemDto

 

0 - *

 

-    -    -    -    id

int32

 

1

Id for kodeliste genstanden.

-    -    -    -    name

string

MinLength: 1

1

Navnet på kodeliste genstanden.

-    -    -    -    isActive

boolean

 

1

Om kodeliste genstanden er aktiv.

-    -    -    -    description

string

MinLength: 1

1

Beskrivelse for kodeliste genstanden.

-    -    -    -    startDate

date-time

 

1

Start dato for kodeliste genstanden.

-    -    -    -    endDate

date-time

 

1

Slut dato for kodeliste genstanden.

Fejlkoder

Ingen fejlkoder

GetAllCodeLists (GET /v1/CodeLists/all)

Returner en liste med kodelister fra alle services

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

AllServicesCodeListDtoCollection

 

1

 

-    AllServicesCodeListDto

AllServicesCodeListDto

 

0 - *

 

-    -    name

string

MinLength: 1

1

Navnet på kodelisten.

-    -    items

CodeListItemDtoCollection

 

1

De tilkoblede kodeliste genstande.

-    -    -    CodeListItemDto

CodeListItemDto

 

0 - *

 

-    -    -    -    id

int32

 

1

Id for kodeliste genstanden.

-    -    -    -    name

string

MinLength: 1

1

Navnet på kodeliste genstanden.

-    -    -    -    isActive

boolean

 

1

Om kodeliste genstanden er aktiv.

-    -    -    -    description

string

MinLength: 1

1

Beskrivelse for kodeliste genstanden.

-    -    -    -    startDate

date-time

 

1

Start dato for kodeliste genstanden.

-    -    -    -    endDate

date-time

 

1

Slut dato for kodeliste genstanden.

-    -    domain

string

MinLength: 1

1

Hvilken silo kodelisten kommer fra.

Fejlkoder

Ingen fejlkoder

GetErrorCodeList (GET /v1/CodeLists/ErrorCodeList)

Returner listen med fejl koder

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

ErrorCodeDtoCollection

 

1

 

-    ErrorCodeDto

ErrorCodeDto

 

0 - *

 

-    -    errorCode

int32

 

1

Fejl koden.

-    -    errorMessage

string

MinLength: 1

1

Fejl beskeden.

-    -    release

string

 

0 - 1

Udgivelse for fejl koden.

Fejlkoder

Ingen fejlkoder

GetAllErrorCodeList (GET /v1/CodeLists/ErrorCodeList/all)

Returner listen med fejl koder fra alle services

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

AllServicesErrorCodeDtoCollection

 

1

 

-    AllServicesErrorCodeDto

AllServicesErrorCodeDto

 

0 - *

 

-    -    errorCode

int32

 

1

Fejl koden.

-    -    errorMessage

string

MinLength: 1

1

Fejl beskeden.

-    -    release

string

 

0 - 1

Udgivelse for fejl koden.

-    -    domain

string

MinLength: 1

1

Hvilken silo fejlkoden kommer fra.

Fejlkoder

Ingen fejlkoder