/
PostDocumentTypes.rst
95 lines (77 loc) · 5.05 KB
/
PostDocumentTypes.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
#############################################################
**Вивантаження списку типів документів з .xlsx файлу**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP POST** |
+==============================================================+============================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | **https://doc.edi-n.com/bdoc/document_types** |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **document_id** - ID документу |
| | |
| | **Опціональні url-параметри:** |
| | |
| | **use_type** - тип документообігу ('1 - external use (зовнішній), 2 - internal use (внутрішній)') |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
В **запиті** методу передається Excel файл.
``RESPONSE``
Опис json-параметрів **відповіді** методу API (масив об'єктів **Document**).
Таблиця 1 - Опис параметрів об'єкта **Document**
.. csv-table::
:file: for_csv/Document.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
В тілі **запиту** передається Excel файл.
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
[
{
"agreementProcId": 0,
"companyId": 4,
"documentId": 2583,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 1,
"name": "Для шифрования",
"type": 1,
"useType": 1
},
{
"agreementProcId": 68,
"code": "423",
"companyId": 4,
"documentId": 1008,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 0,
"name": "О еще один",
"type": 1,
"useType": 1
},
{
"agreementProcId": 0,
"code": "56",
"companyId": 4,
"documentId": 980,
"extraFields": [],
"isActive": 1,
"isProviderAccess": 0,
"name": "для шифрования",
"type": 1,
"useType": 1
}
]