API сервісу Тендер
- Перелік методів API сервісу Тендер
- Помилки при роботі з API
- Видалити групу учасників DELETE /api/v1/tender/participant_group
- Створити/Редагувати групу учасників POST /api/v1/tender/participant_group
- Отримати дані групи учасників GET /api/v1/tender/participant_group
- Отримати список всіх наявних груп учасників GET /api/v1/tender/participant_group/list
- Отримати довідник одиниць виміру GET /api/v1/tender/units
- Отримати довідник регіонів GET /api/v1/tender/regions
- Отримати довідник валют GET /api/v1/tender/currency
- Отримати довідник категорій GET /api/v1/tender/categories
- Видалити підписку на користувача (Адміністратор акаунта) DELETE /api/v1/tender/user/subscribes
- Додати підписку на користувача (Адміністратор акаунта) POST /api/v1/tender/user/subscribes
- Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта GET /api/v1/tender/user/subscribes
- Видалити вкладення до тендера / лота (Організатор) DELETE /api/v1/tender/attachment
- Отримати файл-вкладення до тендера/лота/ставки
- Отримати список вкладень до тендера/лота/ставки GET /api/v1/tender/attachments
- Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) POST /api/v1/tender/attachments
- Відхилити заявку на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/reject
- Схвалити запит на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/confirm
- Отримати дані по заявкам на участь в закритих аукціонах (Учасник) GET /api/v1/tender/auction/access/company/outgoing
- Подати заявку на участь в закритому аукціоні (Учасник) POST /api/v1/tender/auction/access/request
- Запросити компанії взяти участь в тендері (Організатор) POST /api/v1/tender/auction/access/invite
- Завершити тендер (Організатор) PATCH /api/v1/tender/auctions/close
- Отримати список тендерів для неавторизованого користувача GET /api/v1/tender/guest/auctions/all
- Отримати дані про перегляди тендера (за id) GET /api/v1/tender/auction/views
- Отримати список з «Усі тендери» GET /api/v1/tender/auctions/all
- Отримати список тендерів з «Мої тендери» GET /api/v1/tender/auctions/my
- Отримати список тендерів з «Чернеток» GET /api/v1/tender/auctions/drafts
- Отримати дані тендера (за id) GET /api/v1/tender/auction
- Опублікувати тендер PATCH /api/v1/tender/auctions/publish
- Створити новий тендер (чернетку) POST /api/v1/tender/auctions
- Видалити ставку по лоту тендера (Організатор) DELETE /api/v1/tender/lot/bets
- Зробити ставку по лоту (Учасник) POST /api/v1/tender/lot/bets
- Вибір доступних користувачів по компанії GET /api/v1/tender/users
- Надати доступ користувачам до вже опублікованого тендера POST /api/v1/tender/auction/users
- Закрити доступ до вже опублікованого тендера DELETE /api/v1/tender/auction/users
Перелік методів API сервісу Тендер
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Робота зі ставками
|
Зробити ставку по лоту (Учасник) |
POST /api/v1/tender/lot/bets |
|
Видалити ставку по лоту тендера (Організатор) |
DELETE /api/v1/tender/lot/bets |
Робота з тендерами
|
Створити новий тендер (чернетку) |
POST /api/v1/tender/auctions |
|
Опублікувати тендер |
PATCH /api/v1/tender/auctions/publish |
|
Отримати дані тендера (за id) |
GET /api/v1/tender/auction |
|
Отримати список тендерів з "Чернеток" |
GET /api/v1/tender/auctions/drafts |
|
Отримати список тендерів з "Мої тендери" |
GET /api/v1/tender/auctions/my |
|
Отримати список з "Усі тендери" |
GET /api/v1/tender/auctions/all |
|
Отримати дані про перегляди тендера (за id) |
GET /api/v1/tender/auction/views |
|
Отримання списку тендерів для неавторизованого користувача |
GET /api/v1/tender/guest/auctions/all |
|
Завершити тендер (Організатор) |
PATCH /api/v1/tender/auctions/close |
|
Запросити компанії взяти участь в тендері (Організатор) |
POST /api/v1/tender/auction/access/invite |
|
Подати заявку на участь в закритому аукціоні (Учасник) |
POST /api/v1/tender/auction/access/request |
|
Отримати дані по заявкам на участь в закритих аукціонах (Учасник) |
GET /api/v1/tender/auction/access/company/outgoing |
|
Схвалити заявку на участь в закритому аукціоні (Організатор) |
PATCH /api/v1/tender/auction/access/confirm |
|
Відхилити заявку на участь в закритому аукціоні (Організатор) |
PATCH /api/v1/tender/auction/access/reject |
|
Вибір доступних користувачів для компанії |
GET /api/v1/tender/users |
|
Надати доступ до вже опублікованого тендера |
POST /api/v1/tender/auction/users |
|
Закрити доступ до вже опублікованого тендера |
DELETE /api/v1/tender/auction/users |
Вкладення
|
Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) |
POST /api/v1/tender/attachments |
|
Отримати список вкладень до тендера/лота/ставки |
GET /api/v1/tender/attachments |
|
Отримати файл-вкладення до тендера/лота/ставки |
GET /api/v1/tender/attachment |
|
Видалити вкладення до тендера / лота (Організатор) |
DELETE /api/v1/tender/attachment |
Робота з підписками
|
Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта |
GET /api/v1/tender/user/subscribes |
|
Додати підписку на користувача (Адміністратор акаунта) |
POST /api/v1/tender/user/subscribes |
|
Видалити підписку на користувача (Адміністратор акаунта) |
DELETE /api/v1/tender/user/subscribes |
Довідники
|
Отримати довідник категорій |
GET /api/v1/tender/categories |
|
Отримати довідник валют |
GET /api/v1/tender/currency |
|
Отримати довідник регіонів |
GET /api/v1/tender/regions |
|
Отримати довідник одиниць виміру |
GET /api/v1/tender/units |
Довідник учасників
|
Отримати список всіх наявних груп учасників |
GET /api/v1/tender/participant_group/list |
|
Отримати дані групи учасників |
GET /api/v1/tender/participant_group |
|
Створити/Редагувати групу учасників |
POST /api/v1/tender/participant_group |
|
Видалити групу учасників |
DELETE /api/v1/tender/participant_group |
Помилки при роботі з API
Загальні помилки при роботі з API (для всіх сервісів EDIN) можна подивитись за посиланням.
Видалити групу учасників DELETE /api/v1/tender/participant_group
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/participant_group |
|
URL параметри |
group_id (обов’язково) var - ідентифікатор групи учасників |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Створити/Редагувати групу учасників POST /api/v1/tender/participant_group
Вибір дії (створення або редагування): якщо в body запиту присутній ідентифікатор групи учасників (параметр groupId), то група із зазначеним Id підлягає редагуванню. Відсутність в запиті параметра groupId веде до створення нової групи учасників.
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/participant_group |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається об’єкт з даними групи учасників. При редагуванні групи важливо передавати всі необхідні ідентифікатори груп та учасників (id), наприклад «нові та попередні», оскільки запит перезаписує всі значення. |
RESPONSE
В тілі відповіді передається передається об’єкт з даними групи учасників (об'єкт PatrticipantGroup).
Отримати дані групи учасників GET /api/v1/tender/participant_group
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/participant_group |
|
URL параметри |
group_id (обов’язково) var - ідентифікатор групи учасників |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається об’єкт з даними групи учасників (об'єкт ParticipantGroup).
Отримати список всіх наявних груп учасників GET /api/v1/tender/participant_group/list
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/participant_group/list |
|
URL параметри |
limit (опціонально) int - ліміт вибірки (за замовчуванням=20); offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0); count (опціонально) boolean - при значенні true у відповідь пердається лише число - загальна кількість груп учасників. |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається передаються дані груп учасників у вигляді масиву об’єктів.
Отримати довідник одиниць виміру GET /api/v1/tender/units
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/units |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник одиниць виміру (масив об’єктів Unit).
Отримати довідник регіонів GET /api/v1/tender/regions
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/regions |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник регіонів (масив об’єктів Region).
Отримати довідник валют GET /api/v1/tender/currency
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/currency |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник валют (масив об’єктів Currency).
Отримати довідник категорій GET /api/v1/tender/categories
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/categories |
|
URL параметри |
ref_id (опціонально) String - ідентифікатор материнської категорії; query (опціонально) String - текст пошуку (пошук здійснюється за назвою чи кодом категорії); limit (опціонально) int - ліміт вибірки; offset (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається довідник категорій (масив об’єктів Category).
Видалити підписку на користувача (Адміністратор акаунта) DELETE /api/v1/tender/user/subscribes
Даний метод може бути виконаний лише від імені Адміністратора акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/user/subscribes |
|
URL параметри |
user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив кориcтувачів, на яких оформлена підписка (масив об’єктів User ).
Додати підписку на користувача (Адміністратор акаунта) POST /api/v1/tender/user/subscribes
Даний метод може бути виконаний лише від імені Адміністратора акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/user/subscribes |
|
URL параметри |
user_id (обов’язково) long - ідентифікатор користувача |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив користувачів, на яких оформлена підписка (масив об’єктів User ).
Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта GET /api/v1/tender/user/subscribes
Даний метод може бути виконаний лише від імені Адміністратора акаунта.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/user/subscribes |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив користувачів, на яких оформлена підписка (масив об’єктів User ).
Видалити вкладення до тендера / лота (Організатор) DELETE /api/v1/tender/attachment
Видалити вкладення до тендера / лота може лише Організатор тендера чи Супер адміністратор акаунта організації!
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/attachment |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера; attach_id (обов’язково) long - ідентифікатор вкладення (значення id параметра з Отримання списку вкладень до тендера/лота/ставки) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати файл-вкладення до тендера/лота/ставки
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/attachment |
|
URL параметри |
attach_id (обов’язково) long - ідентифікатор вкладення (значення id параметра з Отримання списку вкладень до тендера/лота/ставки) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
MIME типізація згідно типу файлу-вкла дення |
RESPONSE
В тілі відповіді передається файл-вкладення.
Отримати список вкладень до тендера/лота/ставки GET /api/v1/tender/attachments
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/attachments |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера; file_name (обов’язково) String - назва файлу разом з його розширенням; lot_id (опціонально) long - ідентифікатор лоту тендера; bet_id (опціонально) long - ідентифікатор ставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані всіх наявних вкладень (масив об’єктів Attachment).
Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) POST /api/v1/tender/attachments
Додати вкладення до тендера та лота Організатор може лише до початку тендера! Вкладення зі сторони Учасника додається до вже зробленої ним ставки! До кожного тендера / лота / ставки можливо додати до 5 файлів!
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/attachments |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера; file_name (обов’язково) String - назва файлу разом з його розширенням; lot_id (опціонально) long - ідентифікатор лоту тендера; bet_id (опціонально) long - ідентифікатор ставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані доданого вкладення (об’єкт Attachment).
Відхилити заявку на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/reject
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auction/access/reject |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор аукціона (тендера) request_id (обов’язково) long - ідентифікатор запиту |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту в текстовому вигляді опціонально може передаватись коментар до заявки на участь (для Учасника) |
RESPONSE
В тілі відповіді (json) передаються дані заявки на участь в закритому аукціоні (об’єкт Access).
Схвалити запит на участь в закритому аукціоні (Організатор) PATCH /api/v1/tender/auction/access/confirm
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auction/access/confirm |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор аукціона (тендера) request_id (обов’язково) long - ідентифікатор запиту |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту в текстовому вигляді опціонально може передаватись коментар до запиту на участь (для Учасника) |
RESPONSE
В тілі відповіді (json) передаються дані заявки на участь в закритому аукціоні (об’єкт Access).
Отримати дані по заявкам на участь в закритих аукціонах (Учасник) GET /api/v1/tender/auction/access/company/outgoing
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auction/access/company/outgoing |
|
URL параметри |
auction_id (опціонально) long - ідентифікатор аукціона (тендера) company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді (json) передаються дані заявкок на участь в закритих аукціонах (масив об’єктів Access).
Подати заявку на участь в закритому аукціоні (Учасник) POST /api/v1/tender/auction/access/request
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auction/access/request |
|
URL параметри |
auction_uuid (обов’язково) long - унікальний ідентифікатор аукціона (тендера) company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит contact_name (опціонально) String (250) - контактна особа (ПІБ) contact_phone (опціонально) String (50) - контактний телефон contact_email (опціонально) String (250) - контактний email |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту в текстовому вигляді опціонально може передаватись коментар до заявки на участь (для Організатора) |
RESPONSE
В тілі відповіді (json) передаються дані заявки на участь в закритому аукціоні (об’єкт Access).
Запросити компанії взяти участь в тендері (Організатор) POST /api/v1/tender/auction/access/invite
За допомогою даного методу можливо запрошувати до участі в тендері як зареєстровані в сервісі компанії, так і незареєстровані. Після успішного виконання запиту:
-
-
зареєстрована в сервісі компанія додається в Учасники тендера, а користувачам цієї компанії відправляється повідомлення на e-mail з посиланням на тендер;
-
незареєстрованій в сервісі компанії на вказаний e-mail відправляється запрошення на реєстрацію на платформі EDIN 2.0 та посиланням на тендер.
-
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auction/access/invite |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передаються у вигляді масиву об’єктів (по кожній запрошеній компанії):
|
RESPONSE
В тілі відповіді передається об’єкт з access / invites масивами.
Приклад відповіді:
{
"access": ["999321453"],
"invites": ["test2@edin.ua"]
}
де
-
access - масив ЄДРПОУ/ІПН компаній-Учасників, що були запрошені до вказаного тендера (компанії були зареєстровані);
-
invites - масив e-mail адрес, на які відправляється запрошення на реєстрацію.
Завершити тендер (Організатор) PATCH /api/v1/tender/auctions/close
Завершити достроково можливо лише активний (опублікований) тендер. Завершити тендер може лише Організатор, що його створив, та «Супер адміністратор» акаунта цього Організатора.
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auctions/close |
|
URL параметри |
auction_id (обов’язково) String - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Отримати список тендерів для неавторизованого користувача GET /api/v1/tender/guest/auctions/all
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/guest/auctions/all |
|
URL параметри |
Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction).
Отримати дані про перегляди тендера (за id) GET /api/v1/tender/auction/views
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auction/views |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані про перегляди вказаного тендера (масив об’єктів AuctionView).
Отримати список з «Усі тендери» GET /api/v1/tender/auctions/all
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auctions/all |
|
URL параметри |
company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction ).
Отримати список тендерів з «Мої тендери» GET /api/v1/tender/auctions/my
В «Моїх тендерах» відображаються аукціони, які даний користувач створив чи приймає/приймав участь (робив ставку, робив запит на запрошення в тендер чи був запрошений Організатором). Для Супер адміністратора в «Моїх тендерах» відображається така ж інформація, але по відношенню до всіх користувачів акаунту.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auctions/my |
|
URL параметри |
company_id (обов’язково) long - ідентифікатор компанії, від якої здійснюється запит Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction ).
Отримати список тендерів з «Чернеток» GET /api/v1/tender/auctions/drafts
В «Чернетках» відображаються неопубліковані тендери, що були створені даним користувачем. Для Супер адміністратора в «Чернетках» відображається така ж інформація, але відносно всіх користувачів акаунту.
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auctions/drafts |
|
URL параметри |
Можливо додати фільтр (опціональні параметри) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передається масив тендерів (масив об’єктів Auction).
Отримати дані тендера (за id) GET /api/v1/tender/auction
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/auction |
|
URL параметри |
auction_id (обов’язково) long - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді передаються дані вказаного тендера (об’єкт Auction).
Опублікувати тендер PATCH /api/v1/tender/auctions/publish
REQUEST
|
URL |
|
|
Метод запиту |
PATCH |
|
URL запиту |
/api/v1/tender/auctions/publish |
|
URL параметри |
auction_id (обов’язково) String - ідентифікатор тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Створити новий тендер (чернетку) POST /api/v1/tender/auctions
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auctions |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту обов’язково передаються дані нового тендера (об’єкт Auction) |
RESPONSE
В тілі відповіді передаються дані створеного тендера (об’єкт Auction).
Видалити ставку по лоту тендера (Організатор) DELETE /api/v1/tender/lot/bets
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/lot/bets |
|
URL параметри |
lot_id (обов’язково) long - ідентифікатор лоту тендера auction_id (обов’язково) long - ідентифікатор тендера bet_id (обов’язково) long - ідентифікатор ставки |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту обов’язково передається причина видалення ставки (text) |
RESPONSE
В тілі відповіді (json) передається коротке інфо по видаленій ставці (об’єкт):
{"removedBet":96,"comment":"Причина: погода","newBest":357}
де
-
removedBet - ідентифікатор видаленої ставки;
-
comment - коментар (причина видалення);
-
newBest - краща поточна ставка по лоту.
Зробити ставку по лоту (Учасник) POST /api/v1/tender/lot/bets
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/lot/bets |
|
URL параметри |
lot_id (обов’язково) long - ідентифікатор лоту тендера |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту передається об’єкт: {"value":42,"comment":"Коментар2","companyId":447}, де
|
RESPONSE
В тілі відповіді (json) передаються дані зробленої ставки (об’єкт Bet).
Вибір доступних користувачів по компанії GET /api/v1/tender/users
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/v1/tender/users |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
RESPONSE
В тілі відповіді передаються ідентифікатори користувачів у вигляді масиву об'єктів. Також може бути присутня й інша інформація, яка стосується користувача та акаунта.
JSON приклад відповіді:
[
{
"id": 60214599 // ID користувача
},
]
Надати доступ користувачам до вже опублікованого тендера POST /api/v1/tender/auction/users
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/v1/tender/auction/users |
|
URL параметри |
auction_id (обов'язково) - вказується id аукціону, до якого треба надати доступ |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON body |
[users] - масив ідентифікаторів користувачів, яким потрібно надати доступ |
RESPONSE
Код сервера 200 (ok).
Закрити доступ до вже опублікованого тендера DELETE /api/v1/tender/auction/users
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/v1/tender/auction/users |
|
URL параметри |
auction_id (обов'язково) - вказується id аукціону, до якого треба закрити доступ |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON body |
[users] - масив ідентифікаторів користувачів, яким потрібно закрити доступ |
RESPONSE
Код сервера 200 (ok).