Chybové hlášení

Význam a použití

Tato metoda slouží k získání seznamu validačních chybových hlášení (nebo obecně validačních zpráv), které mohou být využívány v rámci komunikace s CPL API. Používá se většinou proto, aby aplikace, která rozhraní využívá, věděla:

Jaké kódy chyb (či varování) mohou nastat v rámci volání jiných metod API (např. při vytváření zásilky, validaci vstupů, generování štítků aj.).

Jakou textovou podobu má konkrétní kód chyby (zpravidla v různých jazycích, nejčastěji v češtině a angličtině).

Doporučený postup řešení nebo detailní popis k dané chybě (někdy bývá součástí message, jindy je kód jen pro programovou obsluhu).

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:

message

string | null

optional

Chybová zpráva

Example

[
  {
    "message": "string"
  }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Chybové hlášení

Význam a použití#

Request

Request samples

Responses

Význam a použití