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

HTTP-запрос

GET https://fleet-api.taxi.yandex.net/v2/parks/contractors/supply-hours?contractor_profile_id={string}&period_from={string}&period_to={string}

Query-параметры

contractor_profile_id *	string Идентификатор профиля водителя
period_from *	string Дата начала периода в формате ISO 8601 с временной зоной
period_to *	string Дата окончания периода в формате ISO 8601 с временной зоной

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

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

X-Park-ID *	string Идентификатор партнера
X-Client-ID *	string Идентификатор клиента
X-API-Key *	string API-ключ

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

Ответы

Код 200

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

{
  "supply_duration_seconds": 3600,
  "total_seconds": 3600
}
Скопировано

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

Свернуть всё

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

Поля

supply_duration_seconds *	integer Время водителя на линии за запрошенный период в секундах
total_seconds *	integer Общая продолжительность запрошенного периода в секундах

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

Код 400

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

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

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

Свернуть всё

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

Поля

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

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

Код 401

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

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

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

Свернуть всё

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

Поля

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

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

Код 403

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

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

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

Свернуть всё

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

Поля

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

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

Код 404

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

{
  "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 GET "https://fleet-api.taxi.yandex.net/v2/parks/contractors/supply-hours?contractor_profile_id={string}\
&period_from={string}\
&period_to={string}" \
-H "X-Park-ID: ee6f33c4562b4e1f8646d157bd70b2c4" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>"
Скопировано

Responses:

{
  "supply_duration_seconds": 3600,
  "total_seconds": 3600
}
Скопировано

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

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

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

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

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

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