/
GetAgreementGroups.rst
99 lines (81 loc) · 5.9 KB
/
GetAgreementGroups.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
#################################################################################################
**Отримання списка групп користувачів для узгодження**
#################################################################################################
Для роботи з цим методом користувач повинен бути `авторизованим <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/agreement_groups**?search_pattern=%D1%84%D0%B8%D0%BD&company_id=1313&limit=30 |
| | |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
| | |
| | **Опціональні url-параметри:(пошук та фільтри):** |
| | |
| | **company_id** - ID компанії (вибірка за компанією) |
| | |
| | **search_pattern** - пошук за назвою групи |
| | |
| | **limit** - ліміт вибірки (за замовчанням=30) |
| | |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
***********************************************************
``REQUEST``
В цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
``RESPONSE``
Опис json-параметрів **відповіді** методу API (об'єкт **AgreementGroup**).
Таблиця 1 - Опис параметрів об'єкта **AgreementGroup**
.. csv-table::
:file: for_csv/AgreementGroup.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
**Приклади**
*********************************
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
--------------
Приклад тіла **відповіді** в json форматі
.. code:: ruby
[
{
"users": [],
"groupId": 301,
"companyId": 1313,
"company": {
"companyId": 0,
"accountId": 0,
"type": 0,
"name": "ФОП Гаврилюк Татьяна",
"code": "3189823647",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"groupName": "Юридический отдел "
},
{
"users": [],
"groupId": 293,
"companyId": 1313,
"company": {
"companyId": 0,
"accountId": 0,
"type": 0,
"name": "ФОП Гаврилюк Татьяна",
"code": "3189823647",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"groupName": "Бухгалтерия"
}
]