/
PostAgreementProc.rst
114 lines (85 loc) · 4.99 KB
/
PostAgreementProc.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
#############################################################
**Створення/редагування процесу узгодження**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
.. important::
Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній **agreementStepId**, то крок узгодження з зазначеним **Id** підлягає редагуванню. Відсутність параметра **agreementStepId** веде до створення нового кроку узгодження.
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP POST** |
+================================================================+========================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **URL запиту** | https://doc.edi-n.com/bdoc/agreement_proc |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається SID - токен, отриманий при авторизації |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| **Обов'язкові параметри, що передаються в тілі запиту (json)** | **agreementProcId** (для редагування), **name**, **companyId** |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
Опис json-параметрів **запиту** метода API (об'єкт **AgreementProc**)
Таблиця 1 - Опис параметрів об'єкта **AgreementProc**
.. csv-table::
:file: for_csv/AgreementProc.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
``RESPONSE``
Опис json-параметрів **відповіді** метода API (об'єкт **AgreementProc**)
Таблиця 2 - Опис параметрів об'єкта **AgreementProc**
.. csv-table::
:file: for_csv/AgreementProc.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 3 - Опис параметрів об'єкта **Company**
.. csv-table::
:file: for_csv/Company.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
Приклад тіла **запиту** (json) для **Створення процесу узгождення**:
.. code:: ruby
{
"name": "ывавы",
"companyId": 989,
"comment": null
}
--------------
Приклад тіла **запиту** (json) для **Редагування процесу узгождення**:
.. code:: ruby
{
"name": "sabaka",
"agreementProcId": 125,
"companyId": 989,
"comment": null
}
--------------
Приклад тіла **відповіді** (json) - однаковий для **Створення/Редагування**:
.. code:: ruby
{
"agrementSteps": [],
"agreementProc2Docs": [],
"agreementProcId": 125,
"companyId": 989,
"company": {
"companyId": 989,
"accountId": 0,
"type": 0,
"name": "dwdsss",
"code": "433",
"isApproved": 0,
"isSignedOffer": 0,
"isActive": 0,
"ownershipTypeId": 0,
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"name": "ывавы",
"status": 1
}