Get

[POST] …/v1/Department/Get

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

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

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


SortOrders

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

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

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

{
    "ids": [
        1
    ],
    "sort_orders": [
        {
            "column": "Name",
            "direction": "desc"
        }
    ],
    "search": "example",
    "limit": 1,
    "offset": 0
}

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

Название Тип данных Описание
result Array of Department Массив отделов
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Бакалея",
            "last_update": 1533619486
        }
    ],
    "next_offset": 1,
    "total": 1
}