/
CreateDictionary.rst
85 lines (63 loc) · 5.33 KB
/
CreateDictionary.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
#############################################################
**Створення/редагування довідника**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
.. important::
Вибір дії (створення або редагування). В разі якщо в тілі запиту (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**
.. csv-table::
:file: for_csv/Dictionary.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
Приклад тіла **запиту** в json форматі:
.. code:: ruby
{
"dictionaryId": 0,
"isActive": 1,
"name": "віфвфывыівфі",
"code": "423423",
"companyId": "989"
}
--------------
Приклад тіла **відповіді** в json форматі:
.. code:: ruby
{
"dictionaryId": 459,
"companyId": 989,
"name": "Как бе справочник",
"code": "423423",
"isActive": 1,
"values": []
}