Відповіді

Після обробки API завжди надає відповідь, звітуючи або про успіх, або про помилку.

Коди стану

У будь-якому випадку API повинен повернути Код стану HTTP, що вказуватиме природу помилки (див. внизу), з тілом відповіді у форматі JSON, що міститиме додаткову інформацію.

200

Успіх. Якщо це був запит про інформацію, то вона буде доступна у data полі на верхньому рівні тіла відповіді.

201

Створено. Його інформація доступна у data полі на верхньому рівні тіла відповіді. API URL, де об’єкт можна прочитати, міститься у Location заголовку відповіді.

400

Неправильний запит. Зазвичай це відбувається через відсутній або неправильний параметр. Перевірте документацію та синтаксис вашого запиту і спробуйте ще раз.

401

Несанкційонований доступ. Не було надано дійсного API ключа разом із запитом, тому API не може зв’язати користувача із запитом.

403

Заборонено. API ключ та синтаксис запиту були дійсними, але сервер відмовляється виконати запит. Це може статися, якщо ви пробуєте прочитати або записати об’єкти чи властивості, до яких не маєте доступу.

404

Ресурс не знайдено. Або даний метод та шлях запиту не вказують відому дію для API, або об’єкт, вказаний у запиті, не існує.

412

Збій під час обробки попередньої умови. Дивіться розділ Pобота з API в режимі API in cluster mode.

429

Перевищено допустиму частоту запитів. Дивіться розділ Контроль частоти запитів.

500

Помилка сервера. Була проблема зі сторони OpenProcurement.

Відповідь з повідомленням про успіх

Кожен успішний запит вичитки, створення, оновлення, чи заміни отримує відповідь, що містить data атрибут. Цей data атрибут містить повне представлення JSON об’єкта після операції. Якщо деякі дані були згенеровані у результаті обробки (наприклад, нові ID об’єкта або modified дата), то вони присутні у відповіді.

Запити списку отримують схожі відповіді, але замість одного об’єкта в data атрибуті, JSON відповідь містить колекцію об’єктів.

Приклад відповіді з повідомленням про успіх

Here is a response that describes ....

Відповідь з повідомленням про помилку

У випадку помилки, тіло відповіді міститиме errors поле на вищому рівні. Воно містить масив як мінімум одного помилкового об’єкта описаного нижче:

location:

Частина запиту спричинює помилку. Можливі значення це header (заголовок) або body (тіло).

name:
  • Конкретна назва заголовку, що спричиняє проблему (у випадку місцярозташування заголовок)

  • Конкретна назва поля, що спричиняє проблему (у випадку місцярозташування тіло)

description:

Докладний (придатний для читання людиною) опис помилки.

Приклад відповіді з повідомленням про помилку

Зразок нижче вказує на неповний запит.