Отримання списку ролей

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edin.ua/bdoc/roles?status=1&company_id=1307&limit=30

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Опціональні url-параметри (фільтр)

search_pattern - пошук по назві ролі

limit - ліміт вибірки (за замовчуванням=20)

offset - зміщення відносно верхньої межі вибірки (за замовчуванням=0)

company_id - id компанії

status - статус ролі (0-всі; 1-активні; 2-заблоковані)

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

В рядку заголовка (Header) додатково передається кількість знайдених ролей за запитом, наприклад:

count: 100500

Опис json-параметрів відповіді метода API (об’єкт Role)

Таблиця 3 - Опис параметрів об’єкта Role

Параметр

Формат

Опис

Об’єкт Role

roleId

long

id ролі

company

Company_

об’єкт; інформація про компанію

companyId

long

id компаниії

name

String

назва ролі

code

String

код ролі

status

int

статус; «1 - активний; 2 - заблокований»

autoBind

int

ознака «Автоматично додавати цю роль всім новим користувачам» 0-Ні; 1-Да

users

List<User_>

масив об’єктів; користувачі

uiTypes

List<UIType2Role_>

масив об’єктів; зв’язки користувальницьких розділів і ролей

packageAccessType

int

тип доступу


Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)


Приклад тіла відповіді (json):

[
  {
    "roleId": 3425,
    "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": "c64a655f76a5404d8d1391e9517abbb0",
    "status": 1,
    "autoBind": 0,
    "users": [],
    "uiTypes": [],
    "packageAccessType": 0
  }
]