/
GetDocumentTypes.rst
99 lines (81 loc) · 6.72 KB
/
GetDocumentTypes.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#############################################################
**Отримання списку всіх документів на рівні компанії**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <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/document_types**?company_id=989&type=0&limit=10&offset=0 |
+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **company_id** - ID компанії |
| | |
| | **use_type** - тип документообігу (1 - external use (зовнішній), 2 - internal use (внутрішній)) |
| | |
| | **Опціональні url-параметри (фільтр)** |
| | |
| | **type** - тип документу (1 - Файл (неструктурований); 2 - Структура; 3 - Динамічна структура; 4 - Таблиця) |
| | |
| | **limit** - ліміт вибірки (за замовчуванням=20) |
| | |
| | **offset** - зміщення відносно верхньої межі вибірки (за замовчуванням=0) |
| | |
| | **is_active** - статус документу; 1 - активний, 0 - заблокований |
+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
``RESPONSE``
Опис json-параметрів **відповіді** методу API (об'єкт **Document**).
Таблиця 1 - Опис параметрів об'єкта **Document**
.. csv-table::
:file: for_csv/Document.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
[
{
"documentId": 2467,
"companyId": 989,
"name": "имя",
"type": 1,
"code": "4324234223425",
"agreementProcId": 0,
"isActive": 1,
"extraFields": []
},
...
{
"documentId": 2385,
"companyId": 989,
"name": "выаыаы",
"type": 1,
"code": "43242342",
"agreementProcId": 0,
"isActive": 1,
"extraFields": []
},
{
"documentId": 2383,
"companyId": 989,
"name": "Для коли",
"type": 1,
"code": "32321321",
"agreementProcId": 0,
"isActive": 1,
"extraFields": []
}
]