Створення/редагування довідника

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній dictionaryId, то довідник з зазначеним Id підлягає редагуванню. Відсутність параметра dictionaryId веде до створення нового довідника.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc/dictionary

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API:

Параметр

Тип

Формат

Опис

dictionaryId

O…M

long

id довідника (передається для редагування (перезатирання) даних раніше створеного довідника)

isActive

M

int

статус довідника; 1 -активний, 0 - заблокований

name

M

String

назва довідника

code

M

String

код довідника

companyId

M

long

id компанії

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Dictionary)

Таблиця 2 - Опис параметрів об’єкта Dictionary

Параметр

Формат

Опис

Об’єкт Dictionary

dictionaryId

long

id довідника

companyId

long

id компании

name

String

назва довідника

code

String

код довідника

isActive

int

статус довідника; 1 - активний, 0 — заблокований

values

List<DictionaryValue_>

масив об’єктів; значення довідника


Приклади

Приклад тіла запиту в json форматі:

{
  "dictionaryId": 0,
  "isActive": 1,
  "name": "віфвфывыівфі",
  "code": "423423",
  "companyId": "989"
}

Приклад тіла відповіді в json форматі:

{
  "dictionaryId": 459,
  "companyId": 989,
  "name": "Как бе справочник",
  "code": "423423",
  "isActive": 1,
  "values": []
}