get

[POST] …/v1/User/get

Возвращает информацию о пользователях системы

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

Название Тип данных Обязательность Описание параметра
ids array of int64 Необязательный Массив id пользователей
group_ids array of int64 Необязательный Массив id групп пользователей
gender enum Необязательный Пол пользователя: male (мужской), female (женский)
can_authorize bool Необязательный Метка пользователя для возможности авторизации в системе
active bool Необязательный Метка пользователя для выполнения действий в системе
language_code string Необязательный Код языка пользователя
sort_orders Sort_orders Необязательный Сортировка выходных данных - Объект класса Sort_orders
search string Необязательный Строка поиска по полям first_name, middle_name, last_name, main_phone, phones
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Описание параметра
column enum Значение для сортировки: Id ( Id пользователя), FirstName (Имя), LastName (Фамилия), MiddleName (Отчество), Sex (Пол), DateOfBirth (Дата рождения), Address (Адрес), MainPhone (Основной телефон), Phones (Доп. телефоны), Email (Email), Description (Доп. описание), Login (Логин),GroupName (Группа пользователей), CanAuthorize (Метка авторизации), Active (Метка активности), TimeZone (Временная зона), LanguageCode (Код языка), LastUpdate (Дата изменения)
direction enum Порядок сортировки: ASC (По возрастанию), DESC (По убыванию)

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

{
    "ids":[1,2],
    "group_ids":[1,2],
    "gender":"male",
    "can_authorize":true,
    "active":true,
    "language_code":"UZ",
    "sort_orders":
    [
        {
        "column":'Name',
        "direction":'desc'
        }
    ],
    "limit":20,
    "offset":3
}

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

Название Тип данных Обязательность Описание параметра
Result array of user Обязательный Массив объектов User

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "user_group": {
                "id": 1,
                "parent_id": 0,
                "name": "Administrators",
                "last_update": 1529755889
            },
            "first_name": "Administrator",
            "last_name": null,
            "middle_name": null,
            "sex": "none",
            "date_of_birth": "1993-12-21",
            "address": null,
            "main_phone": null,
            "phones": null,
            "email": null,
            "description": null,
            "login": "admin",
            "can_authorize": true,
            "active": true,
            "language_code": "RUS",
            "last_update": 1532276019
        }
    ],
    "next_offset": 0,
  "total": 2
}