Створення ролі¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод запиту |
HTTP POST |
---|---|
Content-Type |
application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
URL запиту |
https://doc.edi-n.com/bdoc/role |
Параметри, що передаються в URL (разом з адресою методу) |
В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації |
Обов’язкові параметри, що передаються в тілі запиту (json) |
companyId, name, code |
JSON-параметри в тілі HTTP запиту/відповіді¶
REQUEST
Опис json-параметрів запиту метода API (об’єкт Role)
Таблиця 1 - Опис параметрів об’єкта Role
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Role |
||
roleId |
long |
id ролі |
company |
об’єкт; інформація про компанію |
|
companyId |
long |
id компаниії |
name |
String |
назва ролі |
code |
String |
код ролі |
status |
int |
статус; «1 - активний; 2 - заблокований» |
autoBind |
int |
ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да |
users |
List<User_> |
масив об’єктів; користувачі |
uiTypes |
List<UIType2Role_> |
масив об’єктів; зв’язки користувальницьких розділів і ролей |
packageAccessType |
int |
тип доступу |
В запиті в об’єкті Company передається:
Параметр |
Mandatory/Optional |
Формат |
Опис |
---|---|---|---|
companyId |
M |
long |
id компанії |
RESPONSE
Опис json-параметрів відповіді метода API (об’єкт Role)
Таблиця 3 - Опис параметрів об’єкта Role
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Role |
||
roleId |
long |
id ролі |
company |
об’єкт; інформація про компанію |
|
companyId |
long |
id компаниії |
name |
String |
назва ролі |
code |
String |
код ролі |
status |
int |
статус; «1 - активний; 2 - заблокований» |
autoBind |
int |
ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да |
users |
List<User_> |
масив об’єктів; користувачі |
uiTypes |
List<UIType2Role_> |
масив об’єктів; зв’язки користувальницьких розділів і ролей |
packageAccessType |
int |
тип доступу |
Таблиця 4 - Опис параметрів об’єкта Company
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Company |
||
companyId |
long |
ID компанії |
accountId |
long |
ID аккаунта |
type |
int |
тип компанії (1 - юр. особа; 2 - фіз. особа) |
name |
String |
назва компанії |
legalName |
String |
юридична назва |
inn |
String |
ідентифікаційний номер платника податків |
code |
String |
свідоцтво платника ПДВ |
phone |
String |
телефон |
info |
String |
додаткова інформація |
isApproved |
int |
ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП |
isSignedOffer |
int |
ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так |
isActive |
int |
статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так |
ownershipType |
String |
форма власності |
atCode |
String |
код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України) |
certNum |
String |
свідоцтво платника ПДВ |
uuID |
String |
унікальний ідентифікатор компанії |
bankAcc |
об’єкт; банківські реквізити |
|
legalAddress |
об’єкт; юридична адреса |
|
actualAddress |
об’єкт; фактична адреса |
|
fizName |
об’єкт; ПІБ фіз. особи компанії |
|
certificates |
List<Certificate_> |
масив об’єктів; сертифікати |
dictionaries |
List<Dictionary_> |
масив об’єктів; довідники |
notifySettings |
List<EmailNotifySettings_> |
масив об’єктів; налаштування відправки повідомлень на пошту |
Приклади¶
Приклад тіла запиту (json):
{
"company": {
"companyId": 1307
},
"name": "Чупакабра",
"code": "38d8f5b0f6224565b45726228e1a55b4"
}
Приклад тіла відповіді (json):
{
"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
}