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. V hlavičce Location je URL nově vytvořeného záznamu a v těle odpovědi je i identifikátor.
304 Not Modified Záznam nebyl modifikován (v kombinaci s hlavičkou If-Modified-Since).
400 Bad Request Špatný požadavek. Obvykle nastává při operaci PUT, která selhala (např. odkazujete na objekt, který neexistuje).
401 Unauthorized Uživatel se musí pro provedení dané operace přihlásit.
402 Payment Required Cílový systém nemá aktivované REST API pro zápis. U čtecích operací se vrací 404.
403 Forbidden Uživatel na tuto operaci nemá oprávnění. Tato chyba se zobrazí i v případě, že danou operaci neumožňuje licence.
404 Not Found Záznam nenalezen. Může se jednat o evidenci nebo konkrétní záznam (např. proto, že byl smazán).
406 Not Acceptable Cílový formát není nad konkrétním zdrojem podporovaný (např. export adresáře jako ISDOC).
500 Internal Server Error Při zpracování požadavku nastala vnitřní chyba serveru. Toto by za normálních okolností nemělo nastat a vždy se jedná o chybu v kódu FlexiBee. Informujte nás.

Součástí odpovědi, pokud nejde o chybu 500, je obvykle i popis ve strojově čitelné podobě (XML, JSON). Formát je shodný s validačními zprávami.

Ukázka chybové odpovědi:

<winstrom version="1.0">
  <success>false</success>
  <result>
    <id>105</id>
    <error>Při ukládání došlo k neznámé chybě.</error>
  </result>
</winstrom>