Робота з контрактами / специфікаціями
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Створення нової специфікації (Мережа)
POST /api/es/contract
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/contract?gln=9864119011415 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії (Мережі) |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Електронна специфікація (PRODUCTLIST) в json чи xml форматі відповідно до значення Content-Type |
RESPONSE
В тілі відповіді передається ідентифікатор контракту нової специфікації:
{"contract_uuid": "1a06eda0-2b5f-4fbc-a6d4-3a96d4353da6"}
Оновлення раніше створеної специфікації (Мережа)
PUT /api/es/contract
Даний метод виконується на стороні Мережі.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/es/contract?gln=9864119011415&contract_uuid=8e64b9e4-dfa9-466e-83d5-b3d09c83df87 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії (Мережі); contract_uuid (обов’язково) UUID - GUID контракту / договору |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json or application/xml |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається тіло документа Електронна специфікація (PRODUCTLIST) в json чи xml форматі відповідно до значення Content-Type |
RESPONSE
Код сервера 200 (ok).
Перегляд усіх контрактів/специфікацій
GET /api/es/contracts
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/contracts?gln=9864119011415&expireFrom=1601367101&expireTo=1601539901 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; expireFrom (опціонально) unix timestamp - завершення терміну дії контракту/специфікації «Від»; expireTo (опціонально) unix timestamp - завершення терміну дії контракту/специфікації «До» |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
Приклади формування запиту:
-
отримати всі контракти/специфікації:
GET /api/es/contracts?gln=9864232319962 -
отримати всі актуальні контракти/специфікації:
GET /api/es/contracts?gln=9864232319962&expireFrom=1601539901 -
отримати всі прострочені контракти/специфікації:
GET /api/es/contracts?gln=9864232319962&expireTo=1601539901 -
отримати контракти/специфікації, термін дії яких завершився/завершується у вказаний період:
GET /api/es/contracts?gln=9864232319962&expireFrom=1601367101&expireTo=1601539901
RESPONSE
В тілі відповіді в json-форматі передається об’єкт з інформацією про контракти/специфікації .
Переглянути контракт з конкретним контрагентом
GET /api/es/contract
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/es/contract?gln=9864119011415&contract_uuid=exxxxxxx-85fc-4c58-a07b-833caac25d65 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; contract_uuid (обов’язково) String - GUID контракту / договору |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в json-форматі передається об’єкт з інформацією про контракти .
Видалити контракт/товарні позиції в контракті
DELETE /api/es/contract/data
Для видалення всього контракту разом з усіма його позиціями тіло запиту передавати не потрібно. Для видалення конкретних позицій з контракту в тілі запиту потрібно передавати об’єкт зі списком id позицій з конкретного контракту.
Наприклад:
{
"productID": [
0,
21212121,
113
]
}
Для того, щоб отримати інформацію по контракту з товарними позиціями можна скористатись методом за посиланням.
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/es/contract/data?gln=9864067620417&contract_uuid=ebe77c79-85fc-4c58-a07b-833caac25d65 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; contract_uuid (обов’язково) UUID - GUID контракту |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу може передаватись об’єкт з масивом productID, що містить список id позицій вказаного контракту (видалення позицій). Для видалення контракту тіло запиту не передається. |
RESPONSE
В тілі відповіді в json-форматі передаються деталі результату операції видалення.
Пошук контрактів/специфікацій (з фільтрацією)
POST /api/es/contracts/search
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/es/contracts/search?gln=9864067620417 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid - рядок; унікальний ідентифікатор організації в системі |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передаються критерії пошуку/фільтрації. |
RESPONSE
В тілі відповіді в json-форматі передається масив об’єктів - знайдені контракти/специфікації.
No comments to display
No comments to display