get

[POST] …/v1/DeliveryCourier/get

Возвращает информацию о курьерах

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

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


Sort_orders

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

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

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

{
    "ids":[1,2],
    "sort_orders":
    [
        {
        "column":'Name',
        "direction":'desc'
        }
    ],
    "limit":20,
    "offset":3
}

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

Название Тип данных Обязательность Описание параметра
Result Object of DeliveryFrom Обязательный Объект DeliveryCourier

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

{
    "ok": true,
    "result": 
        [
            {
                "id":1,
                "name":"Александр Александрович",
                "description":"Курьер",
                "last_update": 1534151629
            },
            {
                "id":4,
                "name":"Алексей Алексеевич",
                "description":"Курьер",
                "last_update": 1534151629
            }
        ],
    "next_offset": 0,
  "total": 2
}