Робота з об’єднаним віртуальним довідником (всі сервіси в рамках акаунта/користувача)
Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: https://edo-v2.edin.ua
Для роботи з цими методами користувач повинен бути авторизованим.
Отримати значення з віртуального довідника
GET /api/uds/dictionary
REQUEST
|
URL |
|
|
Метод запиту |
GET |
|
URL запиту |
/api/uds/dictionary?name=TRANSPORT&type=account |
|
URL параметри |
name (обов’язково) - рядок; назва довідника:
type (обов’язково) - рядок; рівень довідника:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
В тілі відповіді в залежності від параметрів запиту передається об’єкт зі значеннями з віртуального довідника в json форматі.
Створити новий довідник
POST /api/uds/dictionary
Важливо! При створенні довідник одразу наповнюється даними.
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/uds/dictionary?name=TRANSPORT&type=account |
|
URL параметри |
name (обов’язково) - рядок; назва довідника:
type (обов’язково) - рядок; рівень довідника:
|
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника |
RESPONSE
У тілі відповіді передається об’єкт з dict_id - ідентифікатором нового довідника:
{"dict_id":2}
Оновити довідник
PUT /api/uds/dictionary
При оновленні довідника всі його дані перезаписуються на нові з тіла запиту.
REQUEST
|
URL |
|
|
Метод запиту |
PUT |
|
URL запиту |
/api/uds/dictionary?dict_id=3 |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника |
RESPONSE
Код сервера 200 (ok).
Видалити довідник
DELETE /api/uds/dictionary
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/uds/dictionary?dict_id=2 |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
RESPONSE
Код сервера 200 (ok).
Додати значення в довідник
POST /api/uds/dictionary/values
REQUEST
|
URL |
|
|
Метод запиту |
POST |
|
URL запиту |
/api/uds/dictionary/values?dict_id=3 |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив об’єктів зі значеннями віртуального довідника |
RESPONSE
Код сервера 200 (ok).
Видалити значення з довідника
DELETE /api/uds/dictionary/values
REQUEST
|
URL |
|
|
Метод запиту |
DELETE |
|
URL запиту |
/api/uds/dictionary/values?dict_id=3 |
|
URL параметри |
dict_id (обов’язково) String - ідентифікатор довідника |
|
Headers |
|
|
Authorization |
SID - токен, отриманий при авторизації |
|
Content-Type |
application/json |
|
REQUEST |
|
|
JSON Body |
В тілі запиту методу передається масив з номером значення із довідника, яке потрібно видалити, наприклад: [23] |
RESPONSE
Код сервера 200 (ok).
No comments to display
No comments to display