Робота з тегами
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з тегами користувач має бути бути авторизованим
Створення нового тегу (мітки)
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/tags?gln=9864065702429 |
|
PARAMS |
|
|
gln |
gln (обов’язково) |
|
HEADERS |
|
|
Authorization |
SID |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається список (масив) назв тегів у вигляді масиву.
Назва тегу (мітки) повинна бути унікальною й довжиною не більше 20 символів.
Приклад: |
RESPONSE
В тілі тілі відповіді в json форматі передається масив створених тегів (Обʼєкт XTag)
[
{
"id": "ід тега",
"name": "назва тега"
},
]Отримання списку тегів (міток)
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
GET |
|
URL запиту |
/api/eds/tags |
|
PARAMS |
|
|
gln |
gln (обов’язково) |
|
search |
пошуковий запит (необовʼязково), не менше 2х символів |
|
Headers |
|
|
Authorization |
SID |
|
Content-Type |
application/json |
RESPONSE
В тілі тілі відповіді в json форматі передається масив тегів (Обʼєкт XTag), що відповідають пошуковому запиту
[
{
"id": "ід тега",
"name": "назва тега"
},
]Привʼязка
Редагування тегу
Видалення тегу
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/eds/tags?gln=9864065702429 |
|
URL параметри |
gln (обов’язково) String - GLN власної Компанії; АБО guid (обов’язково) String - унікальний ідентифікатор власної Компанії |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив ідентифікаторів тегів до видалення, наприклад: |
RESPONSE
Код сервера 200 (ok).
Прив'язка тегу до документа
POST /api/eds/doc/tags
Для виконання пошуку заявок на підключення до мережі, користувач має бути авторизованимREQUEST
REQUEST
|
URL |
https://edo-v2.edin.ua |
|
Метод запиту |
POST |
|
URL запиту |
/api/eds/doc/ |
|
PARAMS |
|
|
gln* |
gln (обов’язково) |
|
doc_id* |
id документа (обовʼязково) |
|
Headers |
|
|
Authorization |
SID |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту (json) передається масив обʼєктів XTag
Приклад: |
RESPONSE
У відповіді повертається повідомлення та статус:
| STATUS | Message | Коментар |
| 200 | Запит успішно опрацьовано | Статус заявки змінено на вказаний |
| 500 | Internal Server Error. Chanel ID: 123456 | Непередбачена внутрішня помилка. Необхідно звернутись до тех. підтримки для зʼясування причини помилки. |