Obsluha chyb
O chybách je uživatel informován pomocí stavového kódu HTTP.
| HTTP kód | Význam |
|---|---|
| 200 OK | Operace byla provedena úspěšně. |
| 201 Created | Záznam byl úspěšně vytvořen. |
| 400 Bad Request | Špatný požadavek. Obvykle nastává při operaci PUT/POST, která selhala (např. odkazujete na objekt, který nesplňuje povinné parametry, popř. neexistuje). Vrací ji také neplatná hodnota URL parametru (např. dry-run, period a from u statistiky inzerátu, nebo limit u tabulky inzerátů); hláška pak vyjmenuje povolené hodnoty parametru. |
| 401 Unauthorized | Pro tuto operaci vyžadujeme přihlášení. |
| 402 Payment Required | Pro tuto operaci nemá uživatel příslušná oprávnění (např. nemá právo pro WRITE, firma je pozastavena, inzerát není v tomto exportu povolen apod.). |
| 403 Forbidden | Nesprávné přihlášení či problémy s login operacemi. |
| 404 Not Found | Záznam nenalezen. Může se jednat o agendu nebo konkrétní záznam (např. proto, že byl smazán). |
| 405 Method Not Allowed | Zadaná HTTP metoda není povolena. |
| 406 Not Acceptable | Požadavek nebyl akceptován. Může znamenat chybu ve struktuře vstupních dat, nebo dalších proměnných při požadavku (např. filter, xpath apod.)Vrací ji také URL parametr, který agenda nepodporuje a který by měnil obsah odpovědi (např. limit u statistiky inzerátu, i s hodnotou 0), a dotaz, který je pro server příliš náročný – hláška řekne, jak ho zmenšit.U tabulky inzerátů ji vrací i parametr section, breakdown, fulltext, ftx-loc nebo usrval-show a order či filter nad sloupcem, který zvolená úroveň detail nevypisuje, nad metrikou, která se ve zvoleném rozsahu neměřila (hláška řekne, od kdy se měří), nebo nad metrikou, která v sekci či zvolených umístěních nevzniká. |
| 410 Gone | Inzerát (agendy moto, dily, prislusenstvi) byl vymazán. |
| 500 Internal Server Error | Na serveru u nás došlo k chybě s konkrétním požadavkem. Pravděpodobně se jedná o chybu v aplikaci. Chyba byla zalogována a tyto řešíme, každopádně máte-li problém, pro urychlení řešení nás kontaktujte. |
| 503 Service Unavailable | Na serveru u nás došlo k chybě a služba jako celek je momentálně nedostupná. |
Součástí odpovědi s chybou, pokud nejde o chybu typu 5xx, je obvykle i popis ve formátu shodném s validačními zprávami.
Ukázka chybové odpovědi:
<tipmoto>
<chyby>
<chyba>Při ukládání došlo k neznámé chybě.</chyba>
</chyby>
</tipmoto>
Protože někteří klienti mají problém se zpracováním HTTP chyb (např. některé knihovny 4xx chyby vyhodnotí jako špatný požadavek a dále jej nezpracovávají), je možné omezit 4xx chybové kódy pomocí ?no-http-errors=true - více viz parametry v URL
Ze stejného důvodu je možné dodat chybové hlášky do výstupního formátu pomocí ?code-in-response=true
Stejně tak - při vytvoření inzerátu je odeslána hlavička Location s umístěním nového inzerátu. Toto je možné potlačit pomocí ?no-http-location=true
