Get

[POST] …/v1/Role/Get

Возвращает информацию о ролях.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of int64 Обязательный Массив id ролей
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка поиска по полям name, description
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
Sort_orders

Модель сортировки выходных параметров

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - Id роли, <Name | 2> - Наименование роли, <Description | 3> - Описание, <LastUpdate | 4> - Дата изменения
direction Enum Необязательный Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

Пример запроса

{
    "ids":[1,2,3,4],
    "sort_orders": [
        {
          "column": "Id",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":4,
    "offset":0
}

Выходные параметры

Название Тип данных Описание
result Array of Role Массив ролей пользователей

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "Admin",
      "description": null,
      "last_update": 1552326674
    },
    {
      "id": 2,
      "name": "Manager",
      "description": null,
      "last_update": 1552326674
    },
    {
      "id": 3,
      "name": "Cashier",
      "description": null,
      "last_update": 1552326674
    },
    {
      "id": 4,
      "name": "System",
      "description": null,
      "last_update": 1552326674
    }
  ],
  "next_offset": 0,
  "total": 4
}