Borgerkommunikation.CodeListsService (Version 1, 2023-4)

Siden opdateres automatisk til at afspejle koden.

Kodelisternes værdisæt findes her: /wiki/display/UDV/Borgerkommunikation.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

 

-    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

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

 

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

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

 

-    -    errorMessage

string

MinLength: 1

1

 

-    -    release

string

 

0 - 1

 

Fejlkoder

Ingen fejlkoder