/
PostContract.rst
170 lines (139 loc) · 6.63 KB
/
PostContract.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
#############################################################
**Створення/редагування контракту**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
.. important::
Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній **contractId**, то контракт з зазначеним **Id** підлягає редагуванню. Відсутність параметра **contractId** веде до створення нового контракту.
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP POST** |
+================================================================+============================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | https://doc.edi-n.com/bdoc/contract |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Обов'язкові параметри, що передаються в тілі запиту (json)** | **contractId (для редагування контракту), clientCompany, companyId, contractName, ownerCompany, number** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
Опис json-параметрів **запиту** метода API (об'єкт **Contract**)
Таблиця 1 - Опис параметрів об'єкта **Contract**
.. csv-table::
:file: for_csv/Contract.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
В **запиті** в об'єкті **Company** передаються:
+-----------+--------------------+--------+-------------+
| Параметр | Mandatory/Optional | Формат | Опис |
+===========+====================+========+=============+
| companyId | M | long | id компанії |
+-----------+--------------------+--------+-------------+
| accountId | O | long | id аккаунту |
+-----------+--------------------+--------+-------------+
``RESPONSE``
Опис json-параметрів **відповіді** метода API (об'єкт **Contract**)
Таблиця 3 - Опис параметрів об'єкта **Contract**
.. csv-table::
:file: for_csv/Contract.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
Таблиця 4 - Опис параметрів об'єкта **Company**
.. csv-table::
:file: for_csv/Company.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
Приклад тіла **запиту** (json) для **Створення контракту**:
.. code:: ruby
{
"clientCompany": {
"companyId": 823
},
"ownerCompany": {
"companyId": 4
},
"contractName": "новый контракт ",
"date": 1554336000,
"description": "фсвымапроло",
"expiredDate": 1554940800,
"number": "1234354656"
}
--------------
Приклад тіла **запиту** (json) для **Редагування контракту**:
.. code:: ruby
{
"contractId": 2129,
"clientCompany": {
"companyId": 823
},
"ownerCompany": {
"companyId": 4
},
"contractName": "новый контракт ",
"date": 1554336000,
"description": "фсвымапроло",
"expiredDate": 1554940800,
"number": "1234354656"
}
--------------
Приклад тіла **відповіді** (json) - однаковий для **Створення/Редагування**:
.. code:: ruby
{
"contractId": 2129,
"contractName": "новый контракт123245465 ",
"date": 0,
"ownerCompany": {
"companyId": 4,
"accountId": 8,
"type": 1,
"name": "Царь Царей",
"legalName": "ПрАТ \"Літак\"",
"inn": "123456789043",
"code": "34554355",
"phone": "4234234324",
"info": "ewdw",
"isApproved": 1,
"isSignedOffer": 1,
"isActive": 1,
"ownershipTypeId": 4,
"atCode": "12363",
"prsNum": "43242352",
"certNum": "456",
"uuid": "a903de62-5b34-43c9-b73a-fb2b8ee4efc1",
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"clientCompany": {
"companyId": 823,
"accountId": 245,
"type": 1,
"name": "tyhtht",
"code": "77778542",
"isApproved": 1,
"isSignedOffer": 1,
"isActive": 1,
"ownershipTypeId": 6,
"uuid": "45953ef9-128d-4e4d-b02d-406a0777fb24",
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"expiredDate": 0,
"sentDate": 0,
"status": 0,
"paymentStatus": 0,
"isSpecialConditions": 0,
"isAllClientSenderPackages": 0,
"isAllOwnerSenderPackages": 0,
"dictionaries": [],
"ownerPackages": [],
"clientPackages": []
}