Редактирование профиля водителя (курьера)

  1. HTTP-запрос
  2. Query-параметры
  3. Заголовки запроса
  4. Тело запроса
    1. Представление
    2. Поля
  5. Ответы
    1. Код 200
    2. Код 400
      1. Представление
      2. Поля
    3. Код 401
      1. Представление
      2. Поля
    4. Код 403
      1. Представление
      2. Поля
    5. Код 404
      1. Представление
      2. Поля
    6. Код 409
      1. Представление
      2. Поля
    7. Код 429
      1. Представление
      2. Поля
    8. Код 500
      1. Представление
      2. Поля
  6. Пример

Редактирование профиля водителя (курьера).
Для упрощения формирования запроса можно воспользоваться API:
GET /v2/parks/contractors/driver-profile

HTTP-запрос

PUT https://fleet-api.taxi.yandex.net/v2/parks/contractors/driver-profile?contractor_profile_id={string}

Query-параметры

contractor_profile_id *

string

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

contractor_profile_id *

string

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

Заголовки запроса

X-Park-ID *

string

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

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

X-Park-ID *

string

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

X-Client-ID *

string

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

X-API-Key *

string

API-ключ

Тело запроса

{
  "account": {
    "balance_limit": "50",
    "block_orders_on_balance_below_limit": false,
    "payment_service_id": "12345",
    "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e"
  },
  "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
  "order_provider": {
    "partner": false,
    "platform": true
  },
  "person": {
    "contact_info": {
      "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
      "email": "example-email@example.com",
      "phone": "+79999999999"
    },
    "driver_license": {
      "birth_date": "1975-10-28",
      "country": "rus",
      "expiry_date": "2050-10-28",
      "issue_date": "2020-10-28",
      "number": "070236"
    },
    "driver_license_experience": {
      "total_since_date": "1970-01-01"
    },
    "full_name": {
      "first_name": "Ivan",
      "last_name": "Ivanov",
      "middle_name": "Ivanovich"
    },
    "tax_identification_number": "7743013902"
  },
  "profile": {
    "comment": "great driver",
    "feedback": "great driver",
    "fire_date": "2020-10-28",
    "hire_date": "2020-10-28",
    "work_status": "working"
  }
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

account *

object

Учетная запись водителя

account.balance_limit *

string

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

account.block_orders_on_balance_below_limit *

boolean

Запрещены ли все заказы при балансе ниже лимита

account.payment_service_id *

string

ID для платежа

account.work_rule_id *

string

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

car_id

string

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

order_provider *

object

order_provider.partner *

boolean

Доступны ли заказы от партнера

order_provider.platform *

boolean

Доступны ли заказы от платформы

person *

object

Персональные данные водителя

person.contact_info *

object

Контактная информация водителя

person.contact_info.address

string

Адрес

person.contact_info.email

string

Электронная почта

person.contact_info.phone *

string

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

person.driver_license *

object

Информация o водительском удостоверении

person.driver_license.birth_date

string

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

person.driver_license.country *

string

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

person.driver_license.expiry_date *

string

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

person.driver_license.issue_date *

string

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

person.driver_license.number *

string

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

person.driver_license_experience

object

Водительский стаж c

person.driver_license_experience.total_since_date *

string

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

person.full_name *

object

Полное имя водителя

person.full_name.first_name *

string

Имя

person.full_name.last_name *

string

Фамилия

person.full_name.middle_name

string

Отчество

person.tax_identification_number

string

Идентификационный номер налогоплательщика

profile *

object

profile.comment

string

Прочее

profile.feedback

string

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

profile.fire_date

string

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

profile.hire_date *

string

Дата приема в парк в формате ISO 8601 без временной зоны

profile.work_status *

string

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

  • working — статус "Работает".
  • not_working — статус "Не работает";
  • fired — статус "Уволен";
Возможные значения
  1. working
  2. not_working
  3. fired

account *

object

Учетная запись водителя

account.balance_limit *

string

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

account.block_orders_on_balance_below_limit *

boolean

Запрещены ли все заказы при балансе ниже лимита

account.payment_service_id *

string

ID для платежа

account.work_rule_id *

string

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

car_id

string

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

order_provider *

object

order_provider.partner *

boolean

Доступны ли заказы от партнера

order_provider.platform *

boolean

Доступны ли заказы от платформы

person *

object

Персональные данные водителя

person.contact_info *

object

Контактная информация водителя

person.contact_info.address

string

Адрес

person.contact_info.email

string

Электронная почта

person.contact_info.phone *

string

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

person.driver_license *

object

Информация o водительском удостоверении

person.driver_license.birth_date

string

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

person.driver_license.country *

string

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

person.driver_license.expiry_date *

string

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

person.driver_license.issue_date *

string

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

person.driver_license.number *

string

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

person.driver_license_experience

object

Водительский стаж c

person.driver_license_experience.total_since_date *

string

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

person.full_name *

object

Полное имя водителя

person.full_name.first_name *

string

Имя

person.full_name.last_name *

string

Фамилия

person.full_name.middle_name

string

Отчество

person.tax_identification_number

string

Идентификационный номер налогоплательщика

profile *

object

profile.comment

string

Прочее

profile.feedback

string

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

profile.fire_date

string

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

profile.hire_date *

string

Дата приема в парк в формате ISO 8601 без временной зоны

profile.work_status *

string

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

  • working — статус "Работает".
  • not_working — статус "Не работает";
  • fired — статус "Уволен";
Возможные значения
  1. working
  2. not_working
  3. fired

Ответы

Код 200

OK

Код 400

Некорректные параметры запроса.
Примеры ошибок:

  • cannot_edit_driver_license_and_full_name_when_dkvu_passed - Запрещено редактирование ФИО водителя или данных водительского удостоверения после проверки.
  • cannot_edit_driver_license_experience_when_dkvu_passed - Запрещено редактирование стажа водителя после проверки.
{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 401

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

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 403

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

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 404

Запрашиваемый ресурс не найден

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 409

Конфликт запроса с текущим состоянием сервера

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 429

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

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Код 500

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

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

code

string

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

message *

string

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

code

string

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

message *

string

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

Пример

Request:

curl -X PUT "https://fleet-api.taxi.yandex.net/v2/parks/contractors/driver-profile?contractor_profile_id={string}" \
-H "X-Park-ID: ee6f33c4562b4e1f8646d157bd70b2c4" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-d '{
  "account": {
    "balance_limit": "50",
    "block_orders_on_balance_below_limit": false,
    "payment_service_id": "12345",
    "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e"
  },
  "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
  "order_provider": {
    "partner": false,
    "platform": true
  },
  "person": {
    "contact_info": {
      "address": "Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63",
      "email": "example-email@example.com",
      "phone": "+79999999999"
    },
    "driver_license": {
      "birth_date": "1975-10-28",
      "country": "rus",
      "expiry_date": "2050-10-28",
      "issue_date": "2020-10-28",
      "number": "070236"
    },
    "driver_license_experience": {
      "total_since_date": "1970-01-01"
    },
    "full_name": {
      "first_name": "Ivan",
      "last_name": "Ivanov",
      "middle_name": "Ivanovich"
    },
    "tax_identification_number": "7743013902"
  },
  "profile": {
    "comment": "great driver",
    "feedback": "great driver",
    "fire_date": "2020-10-28",
    "hire_date": "2020-10-28",
    "work_status": "working"
  }
}'
Скопировано