/
GetPackageComments.rst
97 lines (73 loc) · 4.48 KB
/
GetPackageComments.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
#############################################################
**Отримання журналу комплекту**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP GET** |
+==============================================================+========================================================================================================+
| **Content-Type** | application/json (тіло запиту в form-data в тілі HTTP запиту) |
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **URL запиту** | **https://doc.edi-n.com/bdoc/store/package/comments**?package_id=2137 |
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається SID - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **package_id** - ID комплекту |
+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
``RESPONSE``
У **відповідь** передаються дані з подіями комплекту (об'єкт **PackageComments**) в json форматі
Таблиця 1 - Опис параметрів об'єкта **PackageComments**
.. csv-table::
:file: for_csv/PackageComments.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 2 - Опис параметрів об'єкта **User**
.. csv-table::
:file: for_csv/User.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
[
{
"commentId": 825,
"packageId": 2003,
"user": {
"userId": 4,
"accountId": 0,
"email": "willnotgotomumbai@gmail.com",
"isOwner": 0,
"fio": "Арно Апполинария Петровна",
"companies": [],
"status": 0,
"roles": [],
"routes": [],
"passSecureType": 0,
"passPolicyId": 0,
"lastLoginDate": 0,
"uiTypes": [],
"userAccess": {}
},
"action": 1,
"comment": {
"before": {
"status": 2
},
"after": {
"status": 3
}
},
"date": 1567756601
}