Get

[POST] …/v1/DeliveryCourier/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> - Имя курьера, <Description | 3> - Примечание, <LastUpdate | 4> - Дата изменения
direction Enum Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

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

{
    "ids":[1],
    "sort_orders": [
        {
          "column": "Name",
          "direction": "ASC"
        }
    ],
    "search": "Александр",
    "limit":1,
    "offset":0
}

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

Название Тип данных Описание
result Array of DeliveryCourier Массив курьеров

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Александр",
            "description": "Курьер",
            "last_update": 1534151629
        }
    ],
    "next_offset": 1,
    "total": 1
}