Get

[POST] …/v1/User/Get

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

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

Название Тип данных Обязательность Описание параметра
ids Array of int64 Необязательный Массив id пользователей
group_ids Array of int64 Необязательный Массив id групп пользователей
gender Enum Необязательный Пол пользователя: <None | 1> - не указан, <Male | 2> - мужской, <Female | 3> - женский
can_authorize Boolean Необязательный Метка пользователя для возможности авторизации в системе
active Boolean Необязательный Метка пользователя для выполнения действий в системе
language_code String Необязательный Код языка пользователя
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка поиска по полям: first_name - имя, middle_name - отчество, last_name - фамилия, main_phone - основной телефон, phones - доп. телефон
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


Sort_orders

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

Название Тип данных Обязательность Описание
column Enum Необязательный Значение для сортировки: <Id | 1> - Id пользователя, <FirstName | 2> - Имя, <MiddleName | 3> - Отчество, <LastName | 4> - Фамилия, <Sex | 5> - Пол, <DateOfBirth | 6> - Дата рождения, <Address | 7> - Адрес, <MainPhone | 8> - Основной телефон, <Phones | 9> - Доп. телефоны, <Email | 10> - Email, <Description | 11> - Доп. описание, <Login | 12> - Логин, <GroupName | 13> - Группа пользователей, <CanAuthorize | 14> - Метка авторизации, <Active | 15> - Метка активности, <TimeZone | 16> - Временная зона, <LanguageCode | 17> - Код языка, <LastUpdate | 18> - Дата изменения
direction Enum Необязательный Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

{
    "ids":[1],
    "group_ids":[1],
    "gender":"Male",
    "can_authorize":true,
    "active":true,
    "language_code":"RUS",
    "sort_orders": [
        {
          "column": "Code",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":1,
    "offset":0
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "full_name": "John Fitzgerald Kennedy",
            "main_phone": "998123456789",
            "user_group": {
                "id": 1,
                "parent_id": 1,
                "name": "Administrators",
                "child_count": 1,
                "last_update": 1529755889
            },
            "enable_hints": true,
            "system": true,
            "seller_barcode": "1010000001000000",
            "last_update": 1532276019,
            "first_name": "John",
            "last_name": "Kennedy",
            "middle_name": "Fitzgerald",
            "sex": "Male",
            "date_of_birth": "1993-12-21",
            "address": "456 Elm Street, Suite 3, Los Angeles, CA 90001, USA",
            "phones": "998123456789",
            "email": "example@example.com",
            "description": "example",
            "login": "Admin",
            "can_authorize": true,
            "active": true,
            "language_code": "RUS"
        }
    ],
    "next_offset": 1,
    "total": 1
}