Přejít na obsah
ShopentlyLearn

Požadavky a odpovědi

Vyhodnocujte společně stav HTTP, typovaný obsah JSON a metadata požadavku.

Požadavek

Content-Type: application/json
Zápisy v JSON posílejte s Content-Type: application/json.
data · meta
Úspěšné odpovědi obsahují data a meta; odpovědi se seznamem navíc popisují stránkování.
error.code · error.message
Chyby obsahují error.code, error.message a případně informace o polích.

Datové typy

  • Povinnost uvést pole a možnost hodnoty null jsou nezávislé vlastnosti.
  • Povinné pole může platně obsahovat null, pokud to jeho schéma dovoluje.
  • Zachovávejte logické hodnoty, celá čísla, řetězce a null v JSON bez převádění typů.
  • Peněžní částky jsou desetinné řetězce; ceny nepočítejte pomocí binární aritmetiky s plovoucí desetinnou čárkou.

64-bit · expected_version

  • Některé verze pro řízení souběžných změn používají 64bitová celá čísla se znaménkem.
  • Klient v JavaScriptu musí při hodnotách nad Number.MAX_SAFE_INTEGER zpracovávat JSON bez ztráty přesnosti a odeslat původní celočíselný zápis.
  • Verzi nezaokrouhlujte ani nepřevádějte na řetězec JSON.

Hlavičky

Cache-ControlŘetězecVolitelné

Pravidla ukládání odpovědi do mezipaměti.

const: "no-store"
X-Correlation-IDŘetězecVolitelné

Identifikátor pro sledování tohoto požadavku HTTP.

WWW-AuthenticateŘetězecVolitelné

Způsob ověření požadovaný serverem.

AllowŘetězecVolitelné

Metody HTTP podporované tímto zdrojem.

Retry-AfterCelé čísloVolitelné

Minimální prodleva před opakováním v sekundách.

minimum: 0
LocationŘetězecVolitelné

Relativní URL vytvořeného zdroje.