/
CreateRole.rst
112 lines (86 loc) · 4.6 KB
/
CreateRole.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
#############################################################
**Створення ролі**
#############################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP POST** |
+================================================================+============================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | **https://doc.edin.ua/bdoc/role** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Обов'язкові параметри, що передаються в тілі запиту (json)** | **companyId, name, code** |
+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
Опис json-параметрів **запиту** метода API (об'єкт **Role**)
Таблиця 1 - Опис параметрів об'єкта **Role**
.. csv-table::
:file: for_csv/Role.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
В **запиті** в об'єкті **Company** передається:
+-----------+--------------------+--------+-------------+
| Параметр | Mandatory/Optional | Формат | Опис |
+===========+====================+========+=============+
| companyId | M | long | id компанії |
+-----------+--------------------+--------+-------------+
``RESPONSE``
Опис json-параметрів **відповіді** метода API (об'єкт **Role**)
Таблиця 3 - Опис параметрів об'єкта **Role**
.. csv-table::
:file: for_csv/Role.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
{
"company": {
"companyId": 1307
},
"name": "Чупакабра",
"code": "38d8f5b0f6224565b45726228e1a55b4"
}
--------------
Приклад тіла **відповіді** (json):
.. code:: ruby
{
"roleId": 3427,
"company": {
"companyId": 1307,
"accountId": 8,
"type": 1,
"name": "Для ролей ",
"code": "43343",
"isApproved": 0,
"isSignedOffer": 1,
"isActive": 1,
"ownershipType": "vccv",
"uuid": "7ef5b288-537f-4efd-b175-5993ed2438e3",
"certificates": [],
"dictionaries": [],
"notifySettings": []
},
"companyId": 1307,
"name": "Чупакабра",
"code": "38d8f5b0f6224565b45726228e1a55b4",
"status": 1,
"autoBind": 0,
"users": [],
"uiTypes": [],
"packageAccessType": 0
}