Запити й відповіді

Розглядайте статус HTTP, типізовані дані JSON і метадані запиту разом.

Запит

Content-Type: application/json: Для запису JSON надсилайте Content-Type: application/json.
data · meta: Успішні відповіді містять data та meta; відповіді зі списками додатково описують пагінацію.
error.code · error.message: Помилки містять error.code, error.message та, за потреби, відомості про поля.

Обов’язковість поля й можливість значення null — незалежні властивості.
Обов’язкове поле може містити null, якщо схема це дозволяє.
Зберігайте логічні значення, цілі числа, рядки й null у JSON без перетворення типів.
Грошові суми передаються десятковими рядками; не обчислюйте ціни двійковими числами з рухомою комою.

Деякі версії для контролю одночасних змін є знаковими 64-бітними цілими числами.
Клієнт JavaScript має обробляти JSON без втрати точності для значень понад Number.MAX_SAFE_INTEGER і надсилати початкове ціле число.
Не округлюйте версію й не перетворюйте її на рядок JSON.

Cache-ControlРядокНеобов’язкове: Політика кешування відповіді.

const: "no-store"
X-Correlation-IDРядокНеобов’язкове: Ідентифікатор для відстеження цього запиту HTTP.
WWW-AuthenticateРядокНеобов’язкове: Схема автентифікації, потрібна серверу.
AllowРядокНеобов’язкове: Методи HTTP, підтримувані цим ресурсом.
Retry-AfterЦіле числоНеобов’язкове: Мінімальна затримка перед повтором у секундах.

minimum: 0
LocationРядокНеобов’язкове: Відносний URL створеного ресурсу.