/
GetInternalDocuments.rst
186 lines (158 loc) · 6.96 KB
/
GetInternalDocuments.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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
#############################################################
**Отримання списку внутрішніх документів**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <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/store/internal-documents** |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **folder** - вибір каталога користувача (1- draft (чернетки), 2-sent (відправлені документи)) |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
``RESPONSE``
Опис json-параметрів **відповіді** методу API (об'єкт **DocumentStore**).
Таблиця 1 - Опис параметрів об'єкта **DocumentStore**
.. csv-table::
:file: for_csv/DocumentStore.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 2 - Опис параметрів об'єкта **Company**
.. csv-table::
:file: for_csv/Company.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 3 - Опис параметрів об'єкта **Document**
.. csv-table::
:file: for_csv/Document.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 4 - Опис параметрів об'єкта **DocumentBody**
.. csv-table::
:file: for_csv/DocumentBody.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 5 - Опис параметрів об'єкта **AgreementLogs**
.. csv-table::
:file: for_csv/AgreementLogs.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 6 - Опис параметрів об'єкта **DictionaryValue**
.. csv-table::
:file: for_csv/DictionaryValue.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
[
{
"agreementProcId": 142,
"agreementStatus": 1,
"bodies": [],
"clientSignsCount": 0,
"date": 1562584937,
"dateSent": 0,
"documentId": 6428,
"documentType": {
"agreementProcId": 0,
"companyId": 0,
"documentId": 2676,
"extraFields": [],
"isActive": 0,
"isProviderAccess": 0,
"name": "внутренний",
"type": 1,
"useType": 0
},
"documentUuid": "328ca968-45fd-4b4f-8742-9249b049d4f6",
"extraFields": [],
"isReadFromApi": 0,
"number": "1562584937",
"ownerSignsCount": 0,
"packageId": 0,
"senderCompany": {
"accountId": 8,
"certificates": [],
"code": "34554355",
"companyId": 4,
"dictionaries": [],
"inn": "123456789043",
"isActive": 0,
"isApproved": 0,
"isSignedOffer": 0,
"legalName": "ПрАТ \"Літак\"",
"name": "Царь Царей",
"notifySettings": [],
"ownershipTypeId": 0,
"type": 0
},
"senderCompanyId": 4,
"status": 1,
"versionStructure": 0
},
{
"agreementProcId": 142,
"agreementStatus": 1,
"bodies": [],
"clientSignsCount": 0,
"date": 1561646310,
"dateSent": 0,
"documentId": 6235,
"documentType": {
"agreementProcId": 0,
"companyId": 0,
"documentId": 2676,
"extraFields": [],
"isActive": 0,
"isProviderAccess": 0,
"name": "внутренний",
"type": 1,
"useType": 0
},
"documentUuid": "49ee9089-e5f9-49a9-8807-3323ab925f2c",
"extraFields": [],
"isReadFromApi": 0,
"number": "1561646310",
"ownerSignsCount": 0,
"packageId": 0,
"senderCompany": {
"accountId": 8,
"certificates": [],
"code": "34554355",
"companyId": 4,
"dictionaries": [],
"inn": "123456789043",
"isActive": 0,
"isApproved": 0,
"isSignedOffer": 0,
"legalName": "ПрАТ \"Літак\"",
"name": "Царь Царей",
"notifySettings": [],
"ownershipTypeId": 0,
"type": 0
},
"senderCompanyId": 4,
"status": 1,
"versionStructure": 0
}
]