# API по роботі з довідниками

# Перелік методів API по роботі з довідниками

<p class="callout info">Всі запити нижче перерахованих API методів платформи EDIN 2.0 направляються на адресу: [https://edo-v2.edin.ua](https://edo-v2.edin.ua/)</p>

<p class="callout warning">Для роботи з цими методами користувач повинен бути [авторизованим](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi).</p>

##### **Робота з об'єднаним віртуальним довідником (всі сервіси в рамках акаунта/користувача)**

<table border="1" id="bkmrk-%D0%A1%D1%82%D0%B2%D0%BE%D1%80%D0%B8%D1%82%D0%B8-%D1%81%D0%B5%D1%80%D1%82%D0%B8%D1%84%D1%96%D0%BA%D0%B0%D1%82-" style="width: 99.881%; height: 211.667px;"><colgroup><col style="width: 60.2481%;"></col><col style="width: 39.728%;"></col></colgroup><tbody><tr style="background-color: rgb(236, 240, 241); height: 35.2778px;"><td style="height: 35.2778px;">Отримати значення з віртуального довідника</td><td style="height: 35.2778px;">[GET /api/uds/dictionary](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-znacennia-z-virtualnogo-dovidnika-get-apiudsdictionary)</td></tr><tr style="height: 35.2778px;"><td style="height: 35.2778px;">Створити новий довідник</td><td style="height: 35.2778px;">[POST /api/uds/dictionary](https://wiki-v2.edin.ua/books/robota-z-api/page/stvoriti-novii-dovidnik-post-apiudsdictionary)</td></tr><tr style="background-color: rgb(236, 240, 241); height: 35.2778px;"><td style="height: 35.2778px;">Оновити довідник</td><td style="height: 35.2778px;">[PUT /api/uds/dictionary](https://wiki-v2.edin.ua/books/robota-z-api/page/onoviti-dovidnik-put-apiudsdictionary)</td></tr><tr style="height: 35.2778px;"><td style="height: 35.2778px;">Видалити довідник</td><td style="height: 35.2778px;">[DELETE /api/uds/dictionary](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-dovidnik-delete-apiudsdictionary)</td></tr><tr style="background-color: rgb(236, 240, 241); height: 35.2778px;"><td style="height: 35.2778px;">Додати значення в довідник</td><td style="height: 35.2778px;">[POST /api/uds/dictionary/values](https://wiki-v2.edin.ua/books/robota-z-api/page/dodati-znacennia-v-dovidnik-post-apiudsdictionaryvalues)</td></tr><tr style="height: 35.2778px;"><td style="height: 35.2778px;">Видалити значення з довідника</td><td style="height: 35.2778px;">[DELETE /api/uds/dictionary/values](https://wiki-v2.edin.ua/books/robota-z-api/page/vidaliti-znacennia-z-dovidnika-delete-apiudsdictionaryvalues)</td></tr></tbody></table>

##### **Робота з іншими довідниками**

<table border="1" id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-%D1%96%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D1%96%D1%8E-" style="width: 99.881%;"><colgroup><col style="width: 60.0095%;"></col><col style="width: 39.9666%;"></col></colgroup><tbody><tr style="background-color: rgb(236, 240, 241);"><td>Отримати інформацію по авторизованому користувачу</td><td>[GET /api/oas/user](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-informaciiu-po-avtorizovanomu-koristuvacu-get-apioasuser)</td></tr><tr><td>Отримати інформацію про всіх користувачів компанії (на рівні акаунта)</td><td>[GET /api/oas/account/users](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-informaciiu-pro-vsix-koristuvaciv-kompaniyi-na-rivni-akaunta-get-apioasaccountusers)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td>Отримати інформацію по GLN-номерам, пов'язаним з авторизованим користувачем (на рівні акаунта)</td><td>[GET /api/oas/account/identifiers](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-informaciiu-po-gln-nomeram-poviazanim-z-avtorizovanim-koristuvacem-na-rivni-akaunta-get-apioasaccountidentifiers)</td></tr><tr><td>Отримати перелік роздрібних мереж, пов'язаних із заданим GLN</td><td>[GET /api/oas/retailers](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-perelik-rozdribnix-merez-iaki-poviazani-iz-zadanim-gln-get-apioasretailers)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td>Отримати перелік GLN-номерів, пов'язаних із заданою роздрібною мережею</td><td>[GET /api/oas/retailer/identificators](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-perelik-gln-nomeriv-poviazanix-iz-zadanoiu-rozdribnoiu-merezeiu-get-apioasretaileridentificators)</td></tr><tr><td>Отримати перелік всіх мереж, пов'язаних з авторизованим користувачем</td><td>[GET /api/oas/allretailers](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-perelik-vsix-merez-poviazanix-z-avtorizovanim-koristuvacem-get-apioasallretailers)</td></tr><tr style="background-color: rgb(236, 240, 241);"><td>Отримати перелік доступних одиниць виміру</td><td>[GET /api/oas/units](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-perelik-dostupnix-odinic-vimiru-get-apioasunits)</td></tr><tr><td>Отримати інформацію про організацію по Назві/ІПН/КПП/GLN</td><td>[GET /api/oas/identifiers](https://wiki-v2.edin.ua/books/robota-z-api/page/otrimati-informaciiu-pro-organizaciiu-po-nazviipnkppgln-get-apioasidentifiers)</td></tr></tbody></table>

# Отримати інформацію про організацію по Назві/ІПН/КПП/GLN GET /api/oas/identifiers

Метод дозволяє користувачеві переглядати додаткову інформацію про інші організації на рівні одного загального акаунта, а також знайти Основний GLN за Додатковим GLN.

<p class="callout info">**Основний GLN** має унікальний ЄДРПОУ на рівні платформи. Використовується для документів, що потребують дані юридичної особи та подальшого підписання КЕП. Створюється автоматично при реєстрації на платформі EDI Network.</p>

<p class="callout info">**Додатковий GLN** підв’язується до «Основного GLN». Використовується для указання точок доставки, дрібних магазинів і т.і.</p>

<p class="callout warning">При заповненні GLN у ТТН перевірте правильність формату адреси [**«**Правила заповнення адрес у ТТН та Актах на основі даних із GLN**»**](https://wiki-v2.edin.ua/books/edi-network-produkt-e-ttn/page/pravila-zapovnennia-adres-u-ttn-ta-aktax-na-osnovi-danix-iz-gln)</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 100%;"><colgroup><col style="width: 12.9903%;"></col><col style="width: 86.9964%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/identifiers**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**gln** (обов’язково) String (13) - GLN власної Компанії;

**query** (опціонально) String - текст пошуку (пошук здійснюється за назвою/ІПН/КПП/GLN організації);

**with\_parents** (опціонально) boolean - при true значенні у відповідь передаються дані **Основного GLN** при наявності (параметр parentIdentificator);

**child\_gln** (опціонально) GLN - значення **Додаткового GLN**; якщо передається даний параметр, то у відповідь повертаються дані **Основного GLN**, з яким встановлено зв’язок за **Додатковим GLN**;

**account\_id** (опціонально) String - ідентифікатор акаунта Компанії. В комбінаціях з account\_id параметром можуть застосовуватись додаткові фільтри:

- **katottg\_required** (опціонально) boolean - при true значенні пошук здійснюється лише по записах з заповненим значенням коду КАТОТТГ;
- **is\_company** (опціонально) boolean - при true значенні пошук здійснюється лише за Основним GLN компанії;
- **driver\_license\_required** (опціонально) boolean - при true значенні пошук здійснюється лише по записах з вказаним водійським посвідченням

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається інформація про організацію (масив об’єктів [Identificator](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-identificator)).

# Отримати перелік доступних одиниць виміру GET /api/oas/units

Метод дозволяє відобразити довідник одиниць виміру.

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.8095%;"><colgroup><col style="width: 27.5781%;"></col><col style="width: 72.3925%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/units**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається [довідник одиниць виміру](https://wiki-v2.edin.ua/books/robota-z-api/page/masiv-objektiv-odinic-vimiru).

# Отримати перелік всіх мереж, пов’язаних з авторизованим користувачем GET /api/oas/allretailers

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-%C2%A0-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.3333%;"><colgroup><col style="width: 27.5781%;"></col><col style="width: 72.3925%;"></col></colgroup><tbody><tr class="row-odd"><td> </td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/allretailers**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається [інформація по мережах](https://wiki-v2.edin.ua/books/robota-z-api/page/objekti-informaciyi-po-torgovim-merezax) у вигляді масиву об’єктів.

# Отримати перелік GLN номерів, пов’язаних із заданою роздрібною мережею GET /api/oas/retailer/identificators

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/retailer/identificators**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**retailer\_id** - число; ідентифікатор роздрібної мережі (параметр retailerId з попередніх методів)

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передаються дані про контрагентів (масив об’єктів [Identificator](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-identificator)).

# Отримати перелік роздрібних мереж, які пов’язані із заданим GLN GET /api/oas/retailers

За допомогою цього метода можна отримати перелік всіх роздрібних мереж-контрагентів користувача.

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 98.0952%;"><colgroup><col style="width: 12.7256%;"></col><col style="width: 87.261%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/retailers**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**gln** - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається [інформація про роздрібні мережі](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-retailer).

# Отримати інформацію по GLN номерам, пов’язаним з авторизованим користувачем (на рівні акаунта) GET /api/oas/account/identifiers

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального акаунта.

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.2143%;"><colgroup><col style="width: 27.5781%;"></col><col style="width: 72.3925%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/account/identifiers**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається інформація по GLN номерам у вигляді масиву [об’єктів Identificator](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-identificator).

# Отримати інформацію про всіх користувачів компанії (на рівні акаунта) GET /api/oas/account/users

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.9286%;"><colgroup><col style="width: 19.6209%;"></col><col style="width: 80.3602%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/account/users**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**type** (опціонально) String - тип очікуваної відповіді; можливі варіанти:

- **full** (за замовчуванням)
- **short**

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається інформація про користувачів (масив об’єктів [User](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-user)).

# Отримати інформацію по авторизованому користувачу GET /api/oas/user

За допомогою цього метода можна отримати інформацію про користувача, наприклад ID користувача, ID акаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу та інші ідентифікатори.

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-get"><table class="colwidths-given docutils align-default" style="width: 78.6905%;"><colgroup><col style="width: 27.5781%;"></col><col style="width: 72.3925%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td>  
</td></tr><tr class="row-even"><td>Метод запиту

</td><td>GET

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/oas/user**

</td></tr><tr class="row-even"><td>**Headers**

</td><td> </td></tr><tr class="row-odd"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-even"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі відповіді передається інформація про користувача (об’єкт [User](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-user)).

# Видалити значення з довідника DELETE /api/uds/dictionary/values

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-d"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>DELETE

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/uds/dictionary/values**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**dict\_id** (обов’язково) String - ідентифікатор довідника

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту методу передається масив з номером значення із довідника, яке потрібно видалити, наприклад: \[23\]

</td></tr></tbody></table>

</div>**RESPONSE**

Код сервера 200 (ok).

# Додати значення в довідник POST /api/uds/dictionary/values

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/uds/dictionary/values?dict\_id=3**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**dict\_id** (обов’язково) String - ідентифікатор довідника

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту методу передається масив об’єктів зі [значеннями віртуального довідника](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-z-values-danimi)

</td></tr></tbody></table>

</div>**RESPONSE**

Код сервера 200 (ok).

# Видалити довідник DELETE /api/uds/dictionary

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-d"><table class="colwidths-given docutils align-default" style="width: 78.4524%;"><colgroup><col style="width: 24.053%;"></col><col style="width: 75.9238%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>DELETE

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/uds/dictionary**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**dict\_id** (обов’язково) String - ідентифікатор довідника

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr></tbody></table>

</div>**RESPONSE**

Код сервера 200 (ok).

# Оновити довідник PUT /api/uds/dictionary

<p class="callout warning">При оновленні довідника всі його дані перезаписуються на нові з тіла запиту.</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default" style="width: 86.4286%;"><colgroup><col style="width: 16.7124%;"></col><col style="width: 83.2714%;"></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>PUT

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/uds/dictionary**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**dict\_id** (обов’язково) String - ідентифікатор довідника

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту методу передається масив об’єктів зі [значеннями віртуального довідника](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-z-values-danimi)

</td></tr></tbody></table>

</div>**RESPONSE**

Код сервера 200 (ok).

# Створити новий довідник POST /api/uds/dictionary

<p class="callout warning">Важливо! При створенні довідник одразу наповнюється даними.</p>

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-p"><table class="colwidths-given docutils align-default"><colgroup><col></col><col></col></colgroup><tbody><tr class="row-odd"><td>**URL**

</td><td> </td></tr><tr class="row-even"><td>Метод запиту

</td><td>POST

</td></tr><tr class="row-odd"><td>URL запиту

</td><td>**/api/uds/dictionary**

</td></tr><tr class="row-even"><td>URL параметри

</td><td>**name** (обов’язково) - рядок; назва довідника:

- TRANSPORT - транспортні засоби
- TTN\_RESPONSIBLE\_PERSONS - відповідальні особи
- comdoc\_responsible - відповідальні особи

**type** (обов’язково) - рядок; рівень довідника:

- user - поточний користувач
- account - поточний акаунт

</td></tr><tr class="row-odd"><td>**Headers**

</td><td> </td></tr><tr class="row-even"><td>Authorization

</td><td>**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td>Content-Type

</td><td>application/json

</td></tr><tr class="row-even"><td>**REQUEST**

</td><td> </td></tr><tr class="row-odd"><td>JSON Body

</td><td>В тілі запиту методу передається масив об’єктів зі [значеннями віртуального довідника](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-z-values-danimi)

</td></tr></tbody></table>

</div>**RESPONSE**

У тілі відповіді передається об’єкт з dict\_id - ідентифікатором нового довідника:

```json
{"dict_id":2}
```

# Отримати значення з віртуального довідника GET /api/uds/dictionary

**REQUEST**

<div class="wy-table-responsive" id="bkmrk-url-%C2%A0-%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B7%D0%B0%D0%BF%D0%B8%D1%82%D1%83-g"><table class="colwidths-given docutils align-default" style="width: 78.8095%;"><tbody><tr class="row-odd"><td style="width: 22.1533%;">**URL**

</td><td style="width: 77.8253%;"> </td></tr><tr class="row-even"><td style="width: 22.1533%;">Метод запиту

</td><td style="width: 77.8253%;">GET

</td></tr><tr class="row-odd"><td style="width: 22.1533%;">URL запиту

</td><td style="width: 77.8253%;">**/api/uds/dictionary**

</td></tr><tr class="row-even"><td style="width: 22.1533%;">URL параметри

</td><td style="width: 77.8253%;">**name** (обов’язково) - рядок; назва довідника:

- TRANSPORT - транспортні засоби
- TTN\_RESPONSIBLE\_PERSONS - відповідальні особи
- comdoc\_responsible - відповідальні особи

**type** (обов’язково) - рядок; рівень довідника:

- user - поточний користувач
- account - поточний акаунт

</td></tr><tr class="row-odd"><td style="width: 22.1533%;">**Headers**

</td><td style="width: 77.8253%;"> </td></tr><tr class="row-even"><td style="width: 22.1533%;">Authorization

</td><td style="width: 77.8253%;">**SID** - токен, отриманий при [авторизації](https://wiki-v2.edin.ua/books/robota-z-api/page/metod-avtorizaciyi-na-platformi)

</td></tr><tr class="row-odd"><td style="width: 22.1533%;">Content-Type

</td><td style="width: 77.8253%;">application/json

</td></tr></tbody></table>

</div>**RESPONSE**

В тілі **відповіді** в залежності від параметрів запиту передається об’єкт зі [значеннями з віртуального довідника](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-usersdatastorage) в json форматі.