Додавання значень довідника

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

Підказка

Метод дозволяє додавати «материнські» значення до довідника та прив’язувати до них «дочірні» значення

Метод запиту

HTTP POST

Content-Type

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

URL запиту

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

Параметри, що передаються в 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

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

parentCode

M

String

параметр визначає кейс використання методу:

parentCode=null - створення «материнського» значення

parentCode=»12345» - прив’язка «дочірнього» значения до «материнського 12345»

RESPONSE

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

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

Параметр

Формат

Опис

Об’єкт DictionaryValue

valueId

long

id значення довідника

dictionaryId

long

id довідника

name

String

назва значення довідника

code

String

код значення довідника

parentCode

String

код «батьківського» значення довідника

isActive

int

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


Приклади

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

{
  "name": "СуперВещь",
  "code": "4212522",
  "parentCode": "423423",
  "dictionaryId": 445,
  "isActive": 1
}

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

{
  "valueId": 769,
  "dictionaryId": 445,
  "name": "СуперВещь",
  "code": "4212522",
  "parentCode": "423423",
  "isActive": 1
}