Получение списка профилей водителей (курьеров)

fields

object

Поля профиля, которые необходимо извлечь. Если не указано, то возвращаются все поля профиля.

Чтобы исключить определенный блок полей, передайте пустой массив для соответствующего раздела. Например, чтобы исключить информацию об автомобиле, укажите "car": [].

Пример:

"fields": {
    "car": [],
    "park": [],
    "driver_profile": [
        "first_name",
        "last_name",
        "id"
    ],
    "account": [
        "id",
        "balance",
        "balance_limit",
        "currency"
    ]
}

fields.account[]

array

Данные счёта, которые необходимо извлечь. Допустимые значения:

• id — идентификатор счета;
• type — тип счета;
• balance — текущий баланс счета;
• balance_limit — текущий лимит;
• currency — код валюты в формате ISO 4217.
• last_transaction_date - дата последней транзакции

fields.car[]

array

Данные ТС, которые необходимо извлечь. Допустимые значения:

• id — идентификатор;
• status - статус;
• amenities - услуги;
• category - категории;
• callsign - позывной;
• brand — марка;
• model — модель;
• year — год выпуска;
• color - цвет;
• number — регистрационный номер;
• registration_cert - свидетельство о регистрации (СТС);
• vin - идентификационный номер (VIN).

fields.current_status[]

array

Данные о состоянии водителя, которые необходимо извлечь. Допустимые значения:

• status — текущее состояние водителя;
• status_updated_at — время последнего обновления текущего состояния водителя.

fields.driver_profile[]

array

Данные профиля водителя, которые необходимо извлечь. Допустимые значения:

• id — идентификатор водительского профиля;
• park_id — идентификатор партнера;
• created_date — дата создания профиля в формате ISO 8601;
• first_name — имя;
• last_name — фамилия;
• middle_name — отчество;
• driver_license — информация о водительском удостоверении;
• phones — телефонные номера;
• work_rule_id — идентификатор условия работы;
• work_status — статус работы водителя;
• check_message - отзыв о водителе;
• comment - прочее;
• is_selfemployed - является ли самозанятым;
• has_contract_issue - существуют проблемы с подтверждением занятости.

fields.park[]

array

Данные партнера, которые необходимо извлечь. Допустимые значения:

• id — идентификатор партнера;
• city — город, в котором расположен партнер;
• name — название партнера.

fields.updated_at

boolean

Возвращать ли время последнего обновления

limit

integer

Запрашиваемое число элементов списка

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 1000.

offset

integer

Смещение относительно начала списка

Минимальное значение: 0.

query *

object

Фильтры, объединяются через логическое "И"

query.park

object

Параметры партнера

query.park.account

object

Фильтры по данным счёта

query.park.account.last_transaction_date

object

Полуинтервал времени, хотя бы один конец должен быть указан

query.park.account.last_transaction_date.from

string

Время от в формате ISO 8601

query.park.account.last_transaction_date.to

string

Время до в формате ISO 8601

query.park.driver_profile

object

Фильтры по данным водительского профиля

query.park.driver_profile.id[]

array

Идентификаторы водительских профилей

query.park.driver_profile.work_rule_id[]

array

Идентификаторы условий работы

query.park.driver_profile.work_status[]

array

Статусы работы водителя

query.park.id *

string

Идентификатор партнёра

query.park.updated_at

object

Фильтры по времени последнего обновления; Полуинтервал времени, хотя бы один конец должен быть указан

query.park.updated_at.from

string

Время от в формате ISO 8601

query.park.updated_at.to

string

Время до в формате ISO 8601

query.text

string

Произвольный текстовый поисковый запрос

sort_order[]

array

Массив полей для управления порядком профилей в ответе

sort_order[].direction *

string

Направление сортировки. Допустимые значения:

• asc — сортировка по возрастанию;
• desc — сортировка по убыванию.

1. asc
2. desc

sort_order[].field *

string

Поле, по которому сортируются значения. Допустимые значения:

• account.current.balance — баланс;
• driver_profile.created_date — дата создания;
• driver_profile.last_name — фамилия;
• driver_profile.first_name — имя;
• driver_profile.middle_name — отчество;
• updated_at - время последнего обновления.

1. account.current.balance
2. driver_profile.created_date
3. driver_profile.last_name
4. driver_profile.first_name
5. driver_profile.middle_name
6. updated_at

driver_profiles[] *

array

Список профилей

driver_profiles[].accounts[]

array

Список счетов, которые связаны с водителем.

driver_profiles[].accounts[].balance

string

Текущий баланс (сумма с фиксированной точностью)

driver_profiles[].accounts[].balance_limit

string

Лимит по счету

driver_profiles[].accounts[].currency

string

Валюта в формате ISO 4217

driver_profiles[].accounts[].id

string

Идентификатор счета

driver_profiles[].accounts[].type

string

Тип счета. Допустимые значения:

• current - текущий счёт.

1. current

driver_profiles[].car

object

Данные ТС

driver_profiles[].car.amenities[]

array

Удобства в ТС. Допустимые значения:

• conditioner
• no_smoking
• child_chair
• animal_transport
• universal
• wifi
• check
• card
• yamoney
• newspaper
• coupon
• creditcard
• dont_call
• smoking
• delivery
• vip_event
• woman_driver
• post_terminal
• bicycle
• skiing
• passenger_plus
• cargo_clean
• door_to_door
• sticker
• lightbox

driver_profiles[].car.brand

string

Марка ТС

driver_profiles[].car.callsign

string

Позывной

driver_profiles[].car.category[]

array

Список категорий ТС. Допустимые значения:

• econom - эконом;
• comfort - комфорт;
• comfort_plus - комфорт+;
• business - бизнес;
• minivan - минивен;
• vip - VIP;
• wagon - универсальный;
• pool - pool;
• start - старт;
• standart - стандарт;
• ultimate - премьер;
• maybach - elite;
• promo - промо;
• premium_van - круиз;
• premium_suv - премиум внедорожник;
• suv - внедорожник;
• personal_driver - персональный водитель;
• express - доставка;
• cargo - грузовой.

driver_profiles[].car.color

string

Цвет ТС

1. Белый
2. Желтый
3. Бежевый
4. Черный
5. Голубой
6. Серый
7. Красный
8. Оранжевый
9. Синий
10. Зеленый
11. Коричневый
12. Фиолетовый
13. Розовый

driver_profiles[].car.id *

string

Идентификатор ТС

driver_profiles[].car.model

string

Модель ТС

driver_profiles[].car.number

string

Государственный регистрационный номер

driver_profiles[].car.registration_cert

string

Номер свидетельства о регистрации ТС (Обязательное поле для России)

driver_profiles[].car.status

string

Статус ТС.
Текущие статусы:

• unknown - статус неизвестен;
• working - в данный момент используется для совершения поездок;
• not_working - в данный момент не используется для совершения поездок;
• repairing — подвергается техническому обслуживанию или ремонту;
• no_driver - за машиной не закреплен водитель;
• pending - ведется обработка сведений об автомобиле.

driver_profiles[].car.vin

string

VIN (Обязательное поле для России)

driver_profiles[].car.year

integer

Год выпуска ТС

driver_profiles[].current_status

object

driver_profiles[].current_status.status

string

Текущее состояние водителя. Допустимые значения:

• offline — оффлайн;
• busy — занят;
• free — свободен;
• in_order_free - на заказе, свободен (цепочка включена);
• in_order_busy - на заказе, занят (цепочка выключена).

1. offline
2. busy
3. free
4. in_order_free
5. in_order_busy

driver_profiles[].current_status.status_updated_at

string

Время последнего обновления текущего состояния водителя в формате ISO 8601.

driver_profiles[].driver_profile

object

Профиль водителя

driver_profiles[].driver_profile.check_message

string

Прочее (доступно сотрудникам парка)

driver_profiles[].driver_profile.comment

string

Прочее

driver_profiles[].driver_profile.created_date

string

Дата создания профиля в формате ISO 8601

driver_profiles[].driver_profile.driver_license

object

Водительское удостоверение

driver_profiles[].driver_profile.driver_license.birth_date

string

Дата рождения в формате ISO 8601 без временной зоны

driver_profiles[].driver_profile.driver_license.country *

string

Страна выдачи водительского удостоверения (Трехбуквенный код)

driver_profiles[].driver_profile.driver_license.expiration_date

string

Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны

driver_profiles[].driver_profile.driver_license.issue_date

string

Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны

driver_profiles[].driver_profile.driver_license.normalized_number *

string

Нормализованные серия и номер
(кириллические буквы заменены на латиницу)

driver_profiles[].driver_profile.driver_license.number *

string

Серия и номер водительского удостоверения

driver_profiles[].driver_profile.first_name

string

Имя

driver_profiles[].driver_profile.has_contract_issue

boolean

Существуют проблемы с подтверждением занятости

driver_profiles[].driver_profile.id

string

Идентификатор профиля водителя

driver_profiles[].driver_profile.is_selfemployed

boolean

Является ли самозанятым

driver_profiles[].driver_profile.last_name

string

Фамилия

driver_profiles[].driver_profile.middle_name

string

Отчество

driver_profiles[].driver_profile.park_id

string

Идентификатор партнёра

driver_profiles[].driver_profile.phones[]

array

driver_profiles[].driver_profile.work_rule_id

string

Идентификатор условия работы

driver_profiles[].driver_profile.work_status

string

Статус работы водителя. Допустимые значения:

• working — статус "Работает".
• not_working — статус "Не работает";
• fired — статус "Уволен";

1. working
2. not_working
3. fired

limit *

integer

Запрошённое число элементов списка

offset *

integer

Запрошённое смещение относительно начала списка

parks[] *

array

Список партнеров

parks[].city

string

Город партнера

parks[].id

string

Идентификатор партнёра

parks[].name

string

Название партнера

total *

integer

Общее количество элементов списка

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке