Огляд

openregistry.assets.basic містить документацію з описом роботи з базою даних реєстру активів (RDB).

Особливості

  • Basic asset є представленням активу.

  • Процедура переходить зі статусу draft до pending.

  • Декілька asset’ів, що, поєднуючись, формують лот, позначаються прикріпленими до цього лоту.

  • Єдина валюта (Value.currency), яку можна використати в межах процедури, - гривня (UAH).

Домовленості

API приймає JSON або form-encoded вміст у запитах. Він повертає JSON вміст у всіх свої відповідях, включно з помилками. Підтримується лише UTF-8 кодування і для запитів, і для відповідей.

Всі API POST та PUT запити очікують об’єкт верхнього рівня з єдиним елементом з назвою data. Відповіді з повідомленням про успіх будуть віддзеркалювати цей формат. Елемент data повинен сам бути об’єктом, що містить параметри запиту.

Якщо запит був успішним, ми отримаємо код відповіді 201, який вказує, що об’єкт був створений. Ця відповідь буде мати data поле на верхньому рівні, яке вміщуватиме повну інформацію про новий актив, включно з ID.

Якщо під час запиту виникли труднощі, ми отримаємо інший код стану та JSON, який при поверненні міститиме errors поле на верхньому рівні зі списком проблем. Ми дивимось на першу з них і видруковуємо її повідомлення.

Стан проекту

Статус цього проекту - пре альфа.

Репозиторій джерельних текстів цього проекту є на GitHub: https://github.com/openprocurement/openregistry.api

Стабільність API

API є відносно стабільним. Зміни в API обговорюються через Open Procurement API розсилку.

Change log

0.1

Not Released

  • Set up general build, testing, deployment, and ci framework.
  • Creating/modifying asset

Наступні кроки

You might find it helpful to look at the Туторіал, or the Command Reference.