Get

[POST] …/v1/Brand/Get

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

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

Название Тип данных Обязательность Описание
ids Array of int64 Необязательный Массив id брендов
sort_orders Array of SortOrders Необязательный Сортировка выходных параметров
search String Необязательный Строка поиска по полю name. Поиск применяется, если длина строки больше порога, заданного серверными настройками
limit Int32 Необязательный Лимит возвращаемых данных. Параметр ограничивается серверными настройками (например, query_limit)
offset Int32 Необязательный Смещение от начала выборки. Если значение меньше 0, используется 0
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 Brand Массив брендов
next_offset Int32 Смещение для следующей выборки данных
total Int64 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 81,
            "name": "Coca-Cola",
            "last_update": 1533619486
        }
    ],
    "next_offset": 1,
    "total": 1
}