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