/
GetDictionaries.rst
74 lines (54 loc) · 4.01 KB
/
GetDictionaries.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
#############################################################
**Отримання списку довідників компанії**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP GET** |
+==============================================================+========================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **URL запиту** | **https://doc.edi-n.com/bdoc/dictionaries**?company_id=1313 |
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається SID - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **company_id** - ID компанії |
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
``RESPONSE``
Опис json-параметрів **відповіді** метода API (об'єкт **Dictionary**)
Таблиця 1 - Опис параметрів об'єкта **Dictionary**
.. csv-table::
:file: for_csv/User.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
[
{
"dictionaryId": 715,
"companyId": 1313,
"name": "Направления ",
"code": "e18fac537c49470a8d0a20f4a030edfa",
"isActive": 1,
"values": []
},
{
"dictionaryId": 719,
"companyId": 1313,
"name": "Без значений ",
"code": "68a9aa7931c94170975fda51c94bf204",
"isActive": 1,
"values": []
}
]