Typy osobních dokladů

Význam a použití

Tato metoda vrací předem definovaný seznam kódů a popisků – v tomto případě typů dokladů sloužících k ověření identity. Uživatelé či integrované systémy tak mohou zjistit, jaké typy dokladů (např. občanský průkaz, cestovní pas apod.) jsou v rámci API podporované. Využití najde především v pro:

- Získání seznamu typů dokladů
Pro některé služby (např. výdej balíku proti dokladu) je v API potřeba uvádět, jaký typ dokladu byl použit pro ověření příjemce. Díky codelistu získáte oficiální kód i čitelný název daného typu (typicky v různých jazycích).

- Lokalizovaný popis
Obdobně jako u jiných codelistů, i zde API vrací text (název či popis) v různých jazycích. To se hodí pro zobrazení uživatelům v jejich jazyce.

Request

Query Params

Limit

integer <int32>

required

>= 1<= 1000

Offset

integer <int32>

required

>= 0

Header Params

Accept-Language

string

optional

Language specification, default language: cs-CZ

X-Correlation-ID

string

optional

Correlation Id of request

X-LogLevel

enum<string>

optional

The forced log level

Allowed values:

TraceDebugInformationWarningErrorCritical

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

X-Paging-Total-Items-Count

string

optional

Total items in result

X-Paging-Offset

string

optional

Paging offset

X-Paging-Limit

string

optional

Page size

Body

array of:

name

string | null

optional

Název identifikačního dokladu např. pas,řidičský průkaz...

code

string | null

optional

Kód identifikačního dokladu

Example

[
  {
    "name": "string",
    "code": "string"
  }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Typy osobních dokladů

Význam a použití#

Request

Request samples

Responses

Význam a použití