Создание профиля пешего курьера

HTTP-запрос

POST https://fleet-api.taxi.yandex.net/v2/parks/contractors/walking-courier-profile

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

X-Idempotency-Token *	string Токен идемпотентности запроса, должен состоять только из печатных ASCII символов
X-Client-ID *	string Идентификатор клиента
X-API-Key *	string API-ключ
X-Park-ID *	string Идентификатор партнера

* Обязательный параметр

Тело запроса

{
  "birth_date": "1970-01-01",
  "city": "Москва",
  "full_name": {
    "first_name": "Ivan",
    "last_name": "Ivanov",
    "middle_name": "Ivanovich"
  },
  "phone": "+79999999999",
  "registration_country_code": "RU",
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e"
}
Скопировано

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

Свернуть всё

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

Поля

birth_date *	string Дата в формате ISO 8601 без временной зоны
city	string Город
full_name *	object Полное имя водителя
full_name.first_name *	string Имя
full_name.last_name *	string Фамилия
full_name.middle_name	string Отчество
phone *	string Номер телефона
registration_country_code	string Гражданство (код страны)
work_rule_id *	string Идентификатор условия работы

* Обязательный параметр

Ответы

Код 200

Создание профиля водителя

{
  "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}
Скопировано

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

Свернуть всё

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

Поля

contractor_profile_id *

string

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

* Обязательный параметр

Код 400

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

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

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

Свернуть всё

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

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 429

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

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

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

Свернуть всё

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

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Код 500

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

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

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

Свернуть всё

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

Поля

code	string Машиночитаемый код ошибки
message *	string Человекочитаемое сообщение об ошибке

* Обязательный параметр

Пример

Request:

curl -X POST "https://fleet-api.taxi.yandex.net/v2/parks/contractors/walking-courier-profile" \
-H "X-Idempotency-Token: c56fa6537e5a4adbbce6ef3593210fb9" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-H "X-Park-ID: ee6f33c4562b4e1f8646d157bd70b2c4" \
-d '{
  "birth_date": "1970-01-01",
  "city": "Москва",
  "full_name": {
    "first_name": "Ivan",
    "last_name": "Ivanov",
    "middle_name": "Ivanovich"
  },
  "phone": "+79999999999",
  "registration_country_code": "RU",
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e"
}'
Скопировано

Responses:

{
  "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}
Скопировано

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

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

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