/
PatchUserRoles.rst
76 lines (57 loc) · 4.44 KB
/
PatchUserRoles.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
#########################################################################################
**Редагування (додавання / видалення) зв'язків користувачів з роллю(-ями)**
#########################################################################################
.. attention::
**Додавання / видалення** зв'язків виконується шляхом перезатирання - залишаються тільки ті зв'язки (передаються списком), котрі були передані в останньому запиті!
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP PATCH** |
+==============================================================+============================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | https://doc.edi-n.com/bdoc/user/roles |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **user_id** - ідентифікатор користувача |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**JSON-параметри в тілі HTTP запиту/відповіді**
*******************************************************************
``REQUEST``
В цьому методі в json-тілі **запиту** передаються ідентифікатори ролей (**roleId**), котрі необхідно "прив'язати" до користувача. Дані передаються в вигляді масиву об'єктів.
``RESPONSE``
Опис json-параметрів **відповіді** методу API (об'єкт **Role**).
Таблиця 1 - Опис параметрів об'єкта **Role**
.. csv-table::
:file: for_csv/Role.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
--------------
**Приклади**
*****************
Приклад тіла **запиту** в json форматі:
.. code:: ruby
[
{
"roleId": 128
}
]
--------------
Приклад тіла **відповіді** в json форматі:
.. code:: ruby
[
{
"roleId": 128,
"companyId": 4,
"name": "Новая",
"code": "23",
"status": 1,
"autoBind": 0,
"users": [],
"uiTypes": [],
"packageAccessType": 0
}
]