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

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

Request

POST

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

Headers

Name

Description

X-API-Key

Type: string

API-ключ

Min length: 1

Example: <API-ключ>

X-Client-ID

Type: string

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

Min length: 1

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

X-Idempotency-Token

Type: string

Токен идемпотентности запроса. Должен состоять только из печатных ASCII символов

Min length: 16

Max length: 64

Example: c56fa6537e5a4adbbce6ef3593210fb9

X-Park-ID

Type: string

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

Example: ee6f33c4562b4e1f8646d157bd70b2c4

Body

application/json
{
  "full_name": {
    "first_name": "Ivan",
    "middle_name": "Ivanovich",
    "last_name": "Ivanov"
  },
  "phone": "+79999999999",
  "birth_date": "1970-01-01",
  "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
  "city": "Москва",
  "registration_country_code": "RU"
}

Name

Description

birth_date

Type: Date

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

Example: 1970-01-01

full_name

Type: FullName

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

Example
{
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "last_name": "Ivanov"
}

phone

Type: Phone

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

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

Example: +79999999999

work_rule_id

Type: WorkRuleId

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

Example: bc43tre6ba054dfdb7143ckfgvcby63e

city

Type: City

Город

Min length: 1

Max length: 50

Example: Москва

registration_country_code

Type: RegistrationCountryCode

Гражданство (код страны)

Min length: 1

Max length: 16

Example: RU

FirstName

Имя

Type: string

Example: Ivan

MiddleName

Отчество

Type: string

Example: Ivanovich

LastName

Фамилия

Type: string

Example: Ivanov

FullName

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

Name

Description

first_name

Type: FirstName

Имя

Example: Ivan

last_name

Type: LastName

Фамилия

Example: Ivanov

middle_name

Type: MiddleName

Отчество

Example: Ivanovich

Example
{
  "first_name": "Ivan",
  "middle_name": "Ivanovich",
  "last_name": "Ivanov"
}

Phone

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

Type: string

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

Example: +79999999999

Date

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

Type: string

Example: 1970-01-01

WorkRuleId

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

Type: string

Example: bc43tre6ba054dfdb7143ckfgvcby63e

City

Город

Type: string

Min length: 1

Max length: 50

Example: Москва

RegistrationCountryCode

Гражданство (код страны)

Type: string

Min length: 1

Max length: 16

Example: RU

Responses

200 OK

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

Body

application/json
{
  "contractor_profile_id": "2111ade6gk054dfdb9iu8c8cc9460mks"
}

Name

Description

contractor_profile_id

Type: ContractorProfileId

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

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

ContractorProfileId

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

Type: string

Example: 2111ade6gk054dfdb9iu8c8cc9460mks

400 Bad Request

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

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

No longer supported, please use an alternative and newer version.