status, data, message.
Úspěch
| Pole | Význam |
|---|---|
status | "ok" při úspěchu. |
data | Payload — objekt nebo pole. Může být null, pokud endpoint nic nevrací. |
message | Lidsky čitelná zpráva (např. „Postava byla schválena”). U úspěchu obvykle null. |
Chyba
| Pole | Význam |
|---|---|
status | "error". |
data | Často null. Někdy obsahuje validační chyby per pole. |
message | Krátký popis chyby (lokalizovaný). |
Validační chyby
Pokud endpoint vrátí400 Bad Request kvůli validaci, payload může mít strukturu:
Paginace
Endpointy s listem typicky vrací:| Pole | Význam |
|---|---|
items | Pole záznamů aktuální stránky. |
total | Celkový počet záznamů odpovídajících filtru. |
page | Aktuální stránka (1-based). |
limit | Velikost stránky. |
offset místo page — v reference je to vždy uvedeno.
HTTP statusy
| Status | Význam |
|---|---|
| 200 OK | Úspěch s odpovědí. |
| 201 Created | Úspěšně vytvořeno (POST). |
| 204 No Content | Úspěch bez body (např. DELETE). |
| 400 Bad Request | Validační chyba. |
| 401 Unauthorized | Nejste přihlášený. |
| 403 Forbidden | Přihlášen ale bez práv. |
| 404 Not Found | Záznam neexistuje. |
| 409 Conflict | Konflikt (např. duplikát). |
| 429 Too Many Requests | Rate limit. |
| 500 Internal Server Error | Neočekávaná chyba. |
Lokalizace zpráv
message je vždy v jazyce sezení (default cs_CZ). Pokud klient potřebuje jiný jazyk, posílá Accept-Language hlavičku — server vybere nejvhodnější.