Chybové hlášení

GET

/codelist/validationMessage

Maintainer:Not configured

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

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/codelist/validationMessage?Limit&Offset' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Success

Headers

Body

Example

[
    {
        "message": "string"
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-05 12:29:13

Statusy zásilky /shipment

Typy osobních dokladů

Chybové hlášení

Význam a použití#

Request

Request Code Samples

Responses

Význam a použití