Получает перерывы на отдых

  1. HTTP-запрос
  2. Path-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 404
    5. Код 422

Возвращает информацию о перерывах на отдых в маршруте.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/companies/{company_id}/routes/{route_id}/work_breaks

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

route_id *

integer

ID маршрута, используемый в запросах к API Мониторинга.

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

route_id *

integer

ID маршрута, используемый в запросах к API Мониторинга.

Ответы

Код 200

Информация о перерывах на отдых в маршруте получена.

[
  {
    "id": integer,
    "rest_duration_s": integer,
    "sequence_pos": integer,
    "work_time_range_till_rest": string
  }
]
Скопировано

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

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

Поля

id

integer

ID перерыва на отдых, используемый в запросах к API Мониторинга.

rest_duration_s

integer

Длительность перерыва, секунды

Минимальное значение: 1.

sequence_pos

integer

Порядковый номер перерыва (начиная с 0).

work_time_range_till_rest

string

Время работы до отдыха, формат: [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]].

id

integer

ID перерыва на отдых, используемый в запросах к API Мониторинга.

rest_duration_s

integer

Длительность перерыва, секунды

Минимальное значение: 1.

sequence_pos

integer

Порядковый номер перерыва (начиная с 0).

work_time_range_till_rest

string

Время работы до отдыха, формат: [D.]HH[:MM[:SS]] - [D.]HH[:MM[:SS]].

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

Ошибка доступа к объекту. У пользователя недостаточно прав для доступа к объекту.

Код 404

Ошибка поиска объекта. Объект не найден.

Код 422

Неверный ввод. Операция не может быть выполнена.