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

Возвращает список профилей водителей (курьеров), которые прикреплены к определенному партнеру. Рекомендуется использовать как основной метод получения профилей. Ресурс поддерживает создание пагинации и фильтрации. С помощью ресурса можно получить:

  • все профили водителей (курьеров);
  • все профили водителей (курьеров) с определенным статусом и условием работы;
  • конкретные профили водителей (курьеров) по идентификатору.

Request

POST

https://fleet-api.taxi.yandex.net/v1/parks/driver-profiles/list

Headers

Name

Description

Accept-Language

Type: string

Предпочитаемый язык ответа

Min length: 2

Example: ru

X-API-Key

Type: string

API-ключ

Min length: 1

Example: <API-ключ>

X-Client-ID

Type: string

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

Min length: 1

Example: <Идентификатор клиента>

Body

application/json
{
  "query": {
    "park": {
      "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "driver_profile": {
        "id": [
          "2111ade6gk054dfdb9iu8c8cc9460mks"
        ],
        "work_rule_id": [
          "bc43tre6ba054dfdb7143ckfgvcby63e"
        ],
        "work_status": [
          "working"
        ]
      },
      "current_status": {
        "status": [
          "free"
        ]
      },
      "account": {
        "last_transaction_date": {
          "from": "2025-01-01T00:00:00Z",
          "to": "2025-01-01T00:00:00Z"
        }
      },
      "updated_at": {
        "from": "2025-01-01T00:00:00Z",
        "to": "2025-01-01T00:00:00Z"
      }
    },
    "text": "example"
  },
  "fields": {
    "account": [
      "balance"
    ],
    "car": [
      "color"
    ],
    "current_status": [
      "status"
    ],
    "driver_profile": [
      "last_name"
    ],
    "park": [
      "name"
    ],
    "updated_at": true
  },
  "sort_order": [
    {
      "direction": "asc",
      "field": "driver_profile.created_date"
    }
  ],
  "limit": 200,
  "offset": 0
}

Name

Description

query

Type: DriverProfilesListRequestQuery

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

Example
{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile": {
      "id": [
        "2111ade6gk054dfdb9iu8c8cc9460mks"
      ],
      "work_rule_id": [
        "bc43tre6ba054dfdb7143ckfgvcby63e"
      ],
      "work_status": [
        "working"
      ]
    },
    "current_status": {
      "status": [
        "free"
      ]
    },
    "account": {
      "last_transaction_date": {
        "from": "2025-01-01T00:00:00Z",
        "to": "2025-01-01T00:00:00Z"
      }
    },
    "updated_at": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "text": "example"
}

fields

Type: DriverProfileListRequestFields

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

"fields": {
    "car": [],
    "park": [],
    "driver_profile": [
        "first_name",
        "last_name",
        "id"
    ],
    "account": [
        "id",
        "balance",
        "balance_limit",
        "currency"
    ]
}
Example
{
  "account": [
    "balance"
  ],
  "car": [
    "color"
  ],
  "current_status": [
    "status"
  ],
  "driver_profile": [
    "last_name"
  ],
  "park": [
    "name"
  ],
  "updated_at": true
}

limit

Type: integer

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

Default: 1000

Min value: 1

Max value: 1000

offset

Type: integer

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

Default: 0

Min value: 0

sort_order

Type: DriverProfileRequestSortOrder

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

Example
[
  {
    "direction": "asc",
    "field": "driver_profile.created_date"
  }
]

ParkId

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

Type: string

Example: ee6f33c4562b4e1f8646d157bd70b2c4

ContractorProfileId

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

Type: string

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

WorkRuleId

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

Type: string

Example: bc43tre6ba054dfdb7143ckfgvcby63e

WorkStatus

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

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

Type: string

Enum: working, not_working, fired

DriverProfilesListRequestQueryParkDriverProfile

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

Name

Description

id

Type: ContractorProfileId[]

Example
[
  "2111ade6gk054dfdb9iu8c8cc9460mks"
]

work_rule_id

Type: WorkRuleId[]

Example
[
  "bc43tre6ba054dfdb7143ckfgvcby63e"
]

work_status

Type: WorkStatus[]

Example
[
  "working"
]
Example
{
  "id": [
    "2111ade6gk054dfdb9iu8c8cc9460mks"
  ],
  "work_rule_id": [
    "bc43tre6ba054dfdb7143ckfgvcby63e"
  ],
  "work_status": [
    "working"
  ]
}

DriverStatus

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

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

Type: string

Enum: offline, busy, free, in_order_free, in_order_busy

DriverProfilesListRequestQueryParkCurrentStatus

Фильтр по текущему состоянию водителя

Name

Description

status

Type: DriverStatus[]

Example
[
  "free"
]
Example
{
  "status": [
    "free"
  ]
}

DriverProfilesListRequestQueryParkAccountLastTransactionDate

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

Name

Description

from

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z

to

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z
Example
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}

DriverProfilesListRequestQueryParkAccount

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

Name

Description

last_transaction_date

Type: DriverProfilesListRequestQueryParkAccountLastTransactionDate

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

Example
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
Example
{
  "last_transaction_date": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}

DriverProfilesListRequestQueryParkUpdatedAt

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

Name

Description

from

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z

to

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z
Example
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}

DriverProfilesListRequestQueryPark

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

Name

Description

id

Type: ParkId

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

account

Type: DriverProfilesListRequestQueryParkAccount

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

Example
{
  "last_transaction_date": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}

current_status

Type: DriverProfilesListRequestQueryParkCurrentStatus

Фильтр по текущему состоянию водителя

Example
{
  "status": [
    "free"
  ]
}

driver_profile

Type: DriverProfilesListRequestQueryParkDriverProfile

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

Example
{
  "id": [
    "2111ade6gk054dfdb9iu8c8cc9460mks"
  ],
  "work_rule_id": [
    "bc43tre6ba054dfdb7143ckfgvcby63e"
  ],
  "work_status": [
    "working"
  ]
}

updated_at

Type: DriverProfilesListRequestQueryParkUpdatedAt

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

Example
{
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-01T00:00:00Z"
}
Example
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "driver_profile": {
    "id": [
      "2111ade6gk054dfdb9iu8c8cc9460mks"
    ],
    "work_rule_id": [
      "bc43tre6ba054dfdb7143ckfgvcby63e"
    ],
    "work_status": [
      "working"
    ]
  },
  "current_status": {
    "status": [
      "free"
    ]
  },
  "account": {
    "last_transaction_date": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "updated_at": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}

DriverProfilesListRequestQuery

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

Name

Description

park

Type: DriverProfilesListRequestQueryPark

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

Example
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "driver_profile": {
    "id": [
      "2111ade6gk054dfdb9iu8c8cc9460mks"
    ],
    "work_rule_id": [
      "bc43tre6ba054dfdb7143ckfgvcby63e"
    ],
    "work_status": [
      "working"
    ]
  },
  "current_status": {
    "status": [
      "free"
    ]
  },
  "account": {
    "last_transaction_date": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "updated_at": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-01T00:00:00Z"
  }
}

text

Type: string

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

Example: example
Example
{
  "park": {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "driver_profile": {
      "id": [
        "2111ade6gk054dfdb9iu8c8cc9460mks"
      ],
      "work_rule_id": [
        "bc43tre6ba054dfdb7143ckfgvcby63e"
      ],
      "work_status": [
        "working"
      ]
    },
    "current_status": {
      "status": [
        "free"
      ]
    },
    "account": {
      "last_transaction_date": {
        "from": "2025-01-01T00:00:00Z",
        "to": "2025-01-01T00:00:00Z"
      }
    },
    "updated_at": {
      "from": "2025-01-01T00:00:00Z",
      "to": "2025-01-01T00:00:00Z"
    }
  },
  "text": "example"
}

VehicleField

Поле ТС

Type: string

Enum: id, status, amenities, category, callsign, brand, model, year, color, number, registration_cert, vin

VehicleFields

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

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

Type: VehicleField[]

Example
[
  "color"
]

DriverProfileListRequestFields

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

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

Name

Description

account

Type: string[]

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

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

car

Type: VehicleFields

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

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

current_status

Type: string[]

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

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

driver_profile

Type: string[]

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

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

park

Type: string[]

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

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

updated_at

Type: boolean

Возвращать ли время последнего обновления
Example
{
  "account": [
    "balance"
  ],
  "car": [
    "color"
  ],
  "current_status": [
    "status"
  ],
  "driver_profile": [
    "last_name"
  ],
  "park": [
    "name"
  ],
  "updated_at": true
}

DriverProfileRequestSortOrderField

Name

Description

direction

Type: string

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

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

Enum: asc, desc

field

Type: string

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

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

Enum: account.current.balance, driver_profile.created_date, driver_profile.last_name, driver_profile.first_name, driver_profile.middle_name, updated_at
Example
{
  "direction": "asc",
  "field": "driver_profile.created_date"
}

DriverProfileRequestSortOrder

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

Type: DriverProfileRequestSortOrderField[]

Example
[
  {
    "direction": "asc",
    "field": "driver_profile.created_date"
  }
]

Responses

200 OK

Список водительских профилей получен успешно

Body

application/json
{
  "limit": 200,
  "offset": 0,
  "total": 728,
  "driver_profiles": [
    {
      "accounts": [
        {
          "id": "33de650c6a1a40bfa78dd981817da866",
          "type": "current",
          "balance": "700.0000",
          "balance_limit": "50",
          "currency": "RUB"
        }
      ],
      "car": {
        "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
        "status": "working",
        "amenities": [
          "wifi"
        ],
        "category": [
          "econom"
        ],
        "callsign": "123456789",
        "brand": "Mercedes-Benz",
        "model": "E-klasse",
        "year": 2019,
        "color": "Черный",
        "number": "Т8654Т99",
        "registration_cert": "123456789",
        "vin": "12345678909876543"
      },
      "current_status": {
        "status": "free",
        "status_updated_at": "2020-04-27T08:44:05.871+0000"
      },
      "driver_profile": {
        "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
        "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
        "created_date": "2020-04-23T13:08:05.552+0000",
        "last_name": "Ivanov",
        "first_name": "Ivan",
        "middle_name": "Ivanovich",
        "driver_license": {
          "issue_date": "2020-10-28",
          "expiration_date": "2050-10-28",
          "number": "070236",
          "normalized_number": "AA00123456",
          "country": "rus",
          "birth_date": "1975-10-28"
        },
        "phones": [
          "+79999999999"
        ],
        "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
        "work_status": "working",
        "check_message": "great driver",
        "comment": "great driver",
        "employment_type": "selfemployed",
        "has_contract_issue": true
      }
    }
  ],
  "parks": [
    {
      "id": null,
      "city": "Москва",
      "name": "Рога и Копыта"
    }
  ]
}

Name

Description

driver_profiles

Type: DriverProfile[]

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

Example
[
  {
    "accounts": [
      {
        "id": "33de650c6a1a40bfa78dd981817da866",
        "type": "current",
        "balance": "700.0000",
        "balance_limit": "50",
        "currency": "RUB"
      }
    ],
    "car": {
      "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
      "status": "working",
      "amenities": [
        "wifi"
      ],
      "category": [
        "econom"
      ],
      "callsign": "123456789",
      "brand": "Mercedes-Benz",
      "model": "E-klasse",
      "year": 2019,
      "color": "Черный",
      "number": "Т8654Т99",
      "registration_cert": "123456789",
      "vin": "12345678909876543"
    },
    "current_status": {
      "status": "free",
      "status_updated_at": "2020-04-27T08:44:05.871+0000"
    },
    "driver_profile": {
      "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
      "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
      "created_date": "2020-04-23T13:08:05.552+0000",
      "last_name": "Ivanov",
      "first_name": "Ivan",
      "middle_name": "Ivanovich",
      "driver_license": {
        "issue_date": "2020-10-28",
        "expiration_date": "2050-10-28",
        "number": "070236",
        "normalized_number": "AA00123456",
        "country": "rus",
        "birth_date": "1975-10-28"
      },
      "phones": [
        "+79999999999"
      ],
      "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
      "work_status": "working",
      "check_message": "great driver",
      "comment": "great driver",
      "employment_type": "selfemployed",
      "has_contract_issue": true
    }
  }
]

limit

Type: integer

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

offset

Type: integer

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

parks

Type: DriverProfilePark[]

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

Example
[
  {
    "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "city": "Москва",
    "name": "Рога и Копыта"
  }
]

total

Type: integer

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

AccountId

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

Type: string

Example: 33de650c6a1a40bfa78dd981817da866

AccountType

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

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

Type: string

Const: current

Example: current

AccountBalance

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

Type: string

Example: 700.0000

BalanceLimit

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

Type: string

Example: 50

Currency

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

Type: string

Example: RUB

DriverProfileAccount

Информация о счете

Name

Description

balance

Type: AccountBalance

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

Example: 700.0000

balance_limit

Type: BalanceLimit

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

Example: 50

currency

Type: Currency

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

Example: RUB

id

Type: AccountId

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

Example: 33de650c6a1a40bfa78dd981817da866

type

Type: AccountType

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

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

Enum: current
Example
{
  "id": "33de650c6a1a40bfa78dd981817da866",
  "type": "current",
  "balance": "700.0000",
  "balance_limit": "50",
  "currency": "RUB"
}

VehicleId

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

Type: string

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

Status

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

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

Type: string

Example: working

Amenities

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

  • 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

Type: string[]

Example
[
  "wifi"
]

Categories

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

  • 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 - грузовой.

Type: string[]

Example
[
  "econom"
]

Callsign

Позывной

Type: string

Example: 123456789

Brand

Марка ТС

Type: string

Example: Mercedes-Benz

Model

Модель ТС

Type: string

Example: E-klasse

Year

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

Type: integer

ColorEnum

Цвет ТС

Type: string

Enum: Белый, Желтый, Бежевый, Черный, Голубой, Серый, Красный, Оранжевый, Синий, Зеленый, Коричневый, Фиолетовый, Розовый

LicencePlateNumber

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

Type: string

Example: Т8654Т99

RegistrationCertificate

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

Type: string

Example: 123456789

VIN

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

Type: string

Example: 12345678909876543

Vehicle

Данные ТС

Name

Description

id

Type: VehicleId

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

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

amenities

Type: Amenities

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

  • 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
Example
[
  "wifi"
]

brand

Type: Brand

Марка ТС

Example: Mercedes-Benz

callsign

Type: Callsign

Позывной

Example: 123456789

category

Type: Categories

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

  • 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 - грузовой.
Example
[
  "econom"
]

color

Type: ColorEnum

Цвет ТС

Enum: Белый, Желтый, Бежевый, Черный, Голубой, Серый, Красный, Оранжевый, Синий, Зеленый, Коричневый, Фиолетовый, Розовый

model

Type: Model

Модель ТС

Example: E-klasse

number

Type: LicencePlateNumber

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

Example: Т8654Т99

registration_cert

Type: RegistrationCertificate

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

Example: 123456789

status

Type: Status

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

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

Example: working

vin

Type: VIN

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

Example: 12345678909876543

year

Type: Year

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

Example: 2019
Example
{
  "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
  "status": "working",
  "amenities": [
    "wifi"
  ],
  "category": [
    "econom"
  ],
  "callsign": "123456789",
  "brand": "Mercedes-Benz",
  "model": "E-klasse",
  "year": 2019,
  "color": "Черный",
  "number": "Т8654Т99",
  "registration_cert": "123456789",
  "vin": "12345678909876543"
}

DriverProfileCurrentStatus

Name

Description

status

Type: DriverStatus

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

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

Enum: offline, busy, free, in_order_free, in_order_busy

status_updated_at

Type: string

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

Example: 2020-04-27T08:44:05.871+0000
Example
{
  "status": "free",
  "status_updated_at": "2020-04-27T08:44:05.871+0000"
}

LastName

Фамилия

Type: string

Example: Ivanov

FirstName

Имя

Type: string

Example: Ivan

MiddleName

Отчество

Type: string

Example: Ivanovich

IssueDate

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

Type: string

Example: 2020-10-28

ExpiryDate

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

Type: string

Example: 2050-10-28

Number

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

Type: string

Example: 070236

NormalizedNumber

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

Type: string

Example: AA00123456

CountryCode

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

Type: string

Example: rus

BirthDate

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

Type: string

Example: 1975-10-28

DriverLicense

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

Name

Description

country

Type: CountryCode

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

Example: rus

normalized_number

Type: NormalizedNumber

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

Example: AA00123456

number

Type: Number

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

Example: 070236

birth_date

Type: BirthDate

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

Example: 1975-10-28

expiration_date

Type: ExpiryDate

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

Example: 2050-10-28

issue_date

Type: IssueDate

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

Example: 2020-10-28
Example
{
  "issue_date": "2020-10-28",
  "expiration_date": "2050-10-28",
  "number": "070236",
  "normalized_number": "AA00123456",
  "country": "rus",
  "birth_date": "1975-10-28"
}

Phone

Номер телефона

Type: string

Pattern: ^\+\d{1,15}$

Example: +79999999999

FeedBack

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

Type: string

Example: great driver

Comment

Прочее

Type: string

Example: great driver

EmploymentType

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

  • selfemployed — Парковый самозанятый;
  • park_employee — Парковый исполнитель;
  • individual_entrepreneur — Индивидуальный предприниматель;

Type: string

Enum: selfemployed, park_employee, individual_entrepreneur

HasContractIssue

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

Type: boolean

DriverProfileModel

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

Name

Description

check_message

Type: FeedBack

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

Example: great driver

comment

Type: Comment

Прочее

Example: great driver

created_date

Type: string

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

Example: 2020-04-23T13:08:05.552+0000

driver_license

Type: DriverLicense

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

Example
{
  "issue_date": "2020-10-28",
  "expiration_date": "2050-10-28",
  "number": "070236",
  "normalized_number": "AA00123456",
  "country": "rus",
  "birth_date": "1975-10-28"
}

employment_type

Type: EmploymentType

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

  • selfemployed — Парковый самозанятый;
  • park_employee — Парковый исполнитель;
  • individual_entrepreneur — Индивидуальный предприниматель;

Enum: selfemployed, park_employee, individual_entrepreneur

first_name

Type: FirstName

Имя

Example: Ivan

has_contract_issue

Type: HasContractIssue

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

Example: true

id

Type: ContractorProfileId

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

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

last_name

Type: LastName

Фамилия

Example: Ivanov

middle_name

Type: MiddleName

Отчество

Example: Ivanovich

park_id

Type: ParkId

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

phones

Type: Phone[]

Example
[
  "+79999999999"
]

work_rule_id

Type: WorkRuleId

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

Example: bc43tre6ba054dfdb7143ckfgvcby63e

work_status

Type: WorkStatus

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

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

Enum: working, not_working, fired
Example
{
  "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
  "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "created_date": "2020-04-23T13:08:05.552+0000",
  "last_name": "Ivanov",
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "driver_license": {
    "issue_date": "2020-10-28",
    "expiration_date": "2050-10-28",
    "number": "070236",
    "normalized_number": "AA00123456",
    "country": "rus",
    "birth_date": "1975-10-28"
  },
  "phones": [
    "+79999999999"
  ],
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
  "work_status": "working",
  "check_message": "great driver",
  "comment": "great driver",
  "employment_type": "selfemployed",
  "has_contract_issue": true
}

DriverProfile

Name

Description

accounts

Type: DriverProfileAccount[]

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

Example
[
  {
    "id": "33de650c6a1a40bfa78dd981817da866",
    "type": "current",
    "balance": "700.0000",
    "balance_limit": "50",
    "currency": "RUB"
  }
]

car

Type: Vehicle

Данные ТС

Example
{
  "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
  "status": "working",
  "amenities": [
    "wifi"
  ],
  "category": [
    "econom"
  ],
  "callsign": "123456789",
  "brand": "Mercedes-Benz",
  "model": "E-klasse",
  "year": 2019,
  "color": "Черный",
  "number": "Т8654Т99",
  "registration_cert": "123456789",
  "vin": "12345678909876543"
}

current_status

Type: DriverProfileCurrentStatus

Example
{
  "status": "free",
  "status_updated_at": "2020-04-27T08:44:05.871+0000"
}

driver_profile

Type: DriverProfileModel

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

Example
{
  "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
  "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "created_date": "2020-04-23T13:08:05.552+0000",
  "last_name": "Ivanov",
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "driver_license": {
    "issue_date": "2020-10-28",
    "expiration_date": "2050-10-28",
    "number": "070236",
    "normalized_number": "AA00123456",
    "country": "rus",
    "birth_date": "1975-10-28"
  },
  "phones": [
    "+79999999999"
  ],
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
  "work_status": "working",
  "check_message": "great driver",
  "comment": "great driver",
  "employment_type": "selfemployed",
  "has_contract_issue": true
}
Example
{
  "accounts": [
    {
      "id": "33de650c6a1a40bfa78dd981817da866",
      "type": "current",
      "balance": "700.0000",
      "balance_limit": "50",
      "currency": "RUB"
    }
  ],
  "car": {
    "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
    "status": "working",
    "amenities": [
      "wifi"
    ],
    "category": [
      "econom"
    ],
    "callsign": "123456789",
    "brand": "Mercedes-Benz",
    "model": "E-klasse",
    "year": 2019,
    "color": "Черный",
    "number": "Т8654Т99",
    "registration_cert": "123456789",
    "vin": "12345678909876543"
  },
  "current_status": {
    "status": "free",
    "status_updated_at": "2020-04-27T08:44:05.871+0000"
  },
  "driver_profile": {
    "id": "2111ade6gk054dfdb9iu8c8cc9460mks",
    "park_id": "ee6f33c4562b4e1f8646d157bd70b2c4",
    "created_date": "2020-04-23T13:08:05.552+0000",
    "last_name": "Ivanov",
    "first_name": "Ivan",
    "middle_name": "Ivanovich",
    "driver_license": {
      "issue_date": "2020-10-28",
      "expiration_date": "2050-10-28",
      "number": "070236",
      "normalized_number": "AA00123456",
      "country": "rus",
      "birth_date": "1975-10-28"
    },
    "phones": [
      "+79999999999"
    ],
    "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
    "work_status": "working",
    "check_message": "great driver",
    "comment": "great driver",
    "employment_type": "selfemployed",
    "has_contract_issue": true
  }
}

DriverProfilePark

Name

Description

city

Type: string

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

Example: Москва

id

Type: ParkId

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

name

Type: string

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

Example: Рога и Копыта
Example
{
  "id": "ee6f33c4562b4e1f8646d157bd70b2c4",
  "city": "Москва",
  "name": "Рога и Копыта"
}

400 Bad Request

Некорректные параметры запроса

Body

application/json
{
  "code": "example",
  "message": "Текстовое описание ошибки"
}

Name

Description

message

Type: string

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

Example: Текстовое описание ошибки

code

Type: string

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

Example: example

401 Unauthorized

Отсутствуют параметры авторизации запроса

Body

application/json
{
  "code": "example",
  "message": "Текстовое описание ошибки"
}

Name

Description

message

Type: string

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

Example: Текстовое описание ошибки

code

Type: string

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

Example: example

403 Forbidden

Недостаточно прав для выполнения запроса

Body

application/json
{
  "code": "example",
  "message": "Текстовое описание ошибки"
}

Name

Description

message

Type: string

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

Example: Текстовое описание ошибки

code

Type: string

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

Example: example

429 Too Many Requests

Превышено допустимое число запросов

Body

application/json
{
  "code": "example",
  "message": "Текстовое описание ошибки"
}

Name

Description

message

Type: string

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

Example: Текстовое описание ошибки

code

Type: string

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

Example: example

500 Internal Server Error

Внутренняя ошибка сервера

Body

application/json
{
  "code": "example",
  "message": "Текстовое описание ошибки"
}

Name

Description

message

Type: string

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

Example: Текстовое описание ошибки

code

Type: string

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

Example: example
Предыдущая
Привязка автомобиля к водителю (курьеру)
Следующая
Создание профиля исполнителя с указанием типа сотрудничества