Получение времени водителя на линии

Получение времени водителя на линии

Request

GET

https://fleet-api.taxi.yandex.net/v2/parks/contractors/supply-hours

Query parameters

Name

Description

contractor_profile_id*

Type: string

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

Example: 9b17db0cb1f24a38a5c3c8b4f6e4f63b

period_from*

Type: string<date-time>

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

Example: 2019-08-08T11:58:01+03:00

period_to*

Type: string<date-time>

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

Example: 2019-08-08T11:58:01+03:00

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
{
    "supply_duration_seconds": 3600,
    "total_seconds": 3600
}

Name

Description

supply_duration_seconds*

Type: integer

Время водителя на линии за запрошенный период в секундах

Example: 3600

total_seconds*

Type: integer

Общая продолжительность запрошенного периода в секундах

Example: 3600

400 Bad Request

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

Body

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

Name

Description

message*

Type: string

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

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

code

Type: string

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

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

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