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

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

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

Дата начала периода в формате ISO 8601 с временной зоной. При передаче в URL необходимо использовать URL-encoding для специальных символов: двоеточие : заменяется на %3A, знак плюс + заменяется на %2B. Например: 2019-08-08T11:58:01+03:002019-08-08T11%3A58%3A01%2B03%3A00

Example: 2019-08-08T11%3A58%3A01%2B03%3A00

period_to

Type: string

Дата окончания периода в формате ISO 8601 с временной зоной. При передаче в URL необходимо использовать URL-encoding для специальных символов: двоеточие : заменяется на %3A, знак плюс + заменяется на %2B. Например: 2019-08-08T11:58:01+03:002019-08-08T11%3A58%3A01%2B03%3A00

Example: 2019-08-08T11%3A58%3A01%2B03%3A00

Headers

Name

Description

X-API-Key

Type: string

API-ключ

Min length: 1

Example: <API-ключ>

X-Client-ID

Type: string

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

Min length: 1

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

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

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

total_seconds

Type: integer

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

400 Bad Request

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

401 Unauthorized

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

403 Forbidden

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

Body

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

Name

Description

message

Type: string

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

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

code

Type: string

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

Example: example

404 Not Found

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

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.