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

Request

GET

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

Query parameters

Name

Description

contractor_profile_id*

Type: string

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

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

Headers

Name	Description
X-API-Key*	Type: string API-ключ Example: `<API-ключ>` Min length: `1`
X-Client-ID*	Type: string Идентификатор клиента Example: `<Идентификатор клиента>` Min length: `1`
X-Park-ID*	Type: string Идентификатор партнера Example: `ee6f33c4562b4e1f8646d157bd70b2c4`

Responses

200 OK

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

Body

application/json

{
    "account": {
        "balance_limit": "50",
        "work_rule_id": "bc43tre6ba054dfdb7143ckfgvcby63e",
        "payment_service_id": "12345",
        "block_orders_on_balance_below_limit": false
    },
    "person": {
        "full_name": {
            "first_name": "Ivan",
            "middle_name": "Ivanovich",
            "last_name": "Ivanov"
        },
        "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"
        },
        "tax_identification_number": "7743013902",
        "employment_type": "selfemployed"
    },
    "profile": {
        "hire_date": "2020-10-28",
        "work_status": "working",
        "fire_date": "2020-10-28",
        "comment": "great driver",
        "feedback": "great driver"
    },
    "car_id": "5011ade6ba054dfdb7143c8cc9460dbc",
    "order_provider": {
        "platform": false,
        "partner": false
    }
}

Name	Description
account*	Type: AccountOptional Учетная запись водителя
order_provider*	Type: OrderProvider
person*	Type: PersonOptional Персональные данные водителя
profile*	Type: ProfileOptional
car_id	Type: string Идентификатор автомобиля Example: `5011ade6ba054dfdb7143c8cc9460dbc` Min length: `1` Max length: `100`

AccountOptional

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

Name	Description
balance_limit	Type: string Лимит по счету Example: `50`
block_orders_on_balance_below_limit	Type: boolean Запрещены ли все заказы при балансе ниже лимита
payment_service_id	Type: string ID для платежа Example: `12345`
work_rule_id	Type: string Идентификатор условия работы Example: `bc43tre6ba054dfdb7143ckfgvcby63e`

OrderProvider

Name

Description

partner*

Type: boolean

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

platform*

Type: boolean

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

PersonOptional

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

Name	Description
contact_info	Type: ContactInfoOptional Контактная информация водителя
driver_license	Type: DriverLicenseOptional Информация o водительском удостоверении
driver_license_experience	Type: DriverLicenseExperience Водительский стаж c
employment_type	Type: EmploymentType Тип занятости водителя. Допустимые значения: `selfemployed` — Парковый самозанятый; `park_employee` — Парковый исполнитель; `individual_entrepreneur` — Индивидуальный предприниматель; Example: `selfemployed` Enum: `selfemployed`, `park_employee`, `individual_entrepreneur`
full_name	Type: FullNameOptional Полное имя водителя
tax_identification_number	Type: string Идентификационный номер налогоплательщика Example: `7743013902` Min length: `1`

ProfileOptional

Name	Description
comment	Type: string Прочее Example: `great driver`
feedback	Type: string Прочее (доступно сотрудникам парка) Example: `great driver`
fire_date	Type: string Дата увольнения из парка в формате ISO 8601 без временной зоны Example: `2020-10-28`
hire_date	Type: string Дата приема в парк в формате ISO 8601 без временной зоны Example: `2020-10-28`
work_status	Type: WorkStatus Статус работы водителя. Допустимые значения: `working` — статус "Работает". `not_working` — статус "Не работает"; `fired` — статус "Уволен"; Example: `working` Enum: `working`, `not_working`, `fired`

ContactInfoOptional

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

Name	Description
address	Type: string Адрес Example: `Moscow, Ivanovskaya Ul., bld. 40/2, appt. 63`
email	Type: string Электронная почта Example: `example-email@example.com`
phone	Type: string Номер телефона Example: `+79999999999` Pattern: `^\+\d{1,15}$`

DriverLicenseOptional

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

Name	Description
birth_date	Type: string Дата рождения в формате ISO 8601 без временной зоны Example: `1975-10-28`
country	Type: string Страна выдачи водительского удостоверения (Трехбуквенный код) Example: `rus`
expiry_date	Type: string Дата окончания действия водительского удостоверения в формате ISO 8601 без временной зоны Example: `2050-10-28`
issue_date	Type: string Дата выдачи водительского удостоверения в формате ISO 8601 без временной зоны Example: `2020-10-28`
number	Type: string Серия и номер водительского удостоверения Example: `070236`

DriverLicenseExperience

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

Name

Description

total_since_date*

Type: string

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

Example: 1970-01-01

EmploymentType

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

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

Type

Description

EmploymentType

Example: selfemployed

Enum: selfemployed, park_employee, individual_entrepreneur

FullNameOptional

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

Name	Description
first_name	Type: string Имя Example: `Ivan`
last_name	Type: string Фамилия Example: `Ivanov`
middle_name	Type: string Отчество Example: `Ivanovich`

WorkStatus

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

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

Type

Description

WorkStatus

Example: working

Enum: working, not_working, fired

401 Unauthorized

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

403 Forbidden

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

404 Not Found

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

429 Too Many Requests

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

500 Internal Server Error

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

Body

application/json

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

Была ли статья полезна?

Создание профиля исполнителя с указанием типа сотрудничества

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