Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Запрос getScheduleByVehicleRun

Для получения расписания по рейсу машины API использует структуру application/x-www-form-urlencoded и HTTP-метод POST.


Входные данные запроса getScheduleByVehicleRun

Входные данные должны отправляться как атрибуты и не должны находиться в теле запроса. Список всех поддерживаемых атрибутов представлен ниже.

#

Название атрибута

Тип

Стиль

Обязательность

Описание

1

sessionID

Текст


Да

Идентификатор сессии, полученный от сервера после запроса авторизации.

Срок жизни сессии – 5 минут. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут

2

date

Дата

Query

Да

Запрашиваемая дата. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат – “DD/MM/YYYY”. Для России – “ДД.MM.ГГГГ”

3

vehicleID

Целое число

Query

Да

Идентификатор машины

4

runNumber

Целое число

Query

Да

Идентификатор поездки указанной машины


Пример запроса getScheduleByVehicleRun


Заголовки:

Метод: POST

URL: [account-name].maxoptra.com/rest/2/distribution-api/schedules/getScheduleByVehicleRun?sessionID=8aa519d2c0af4f37a27a42a995528199&date=28/01/2014&vehicleID=1175&runNumber=1

Структура: application/x-www-form-urlencoded

Тело запроса: не должно содержать никакой информации

Ответ getScheduleByVehicleRun

Для получения расписания API использует структуру application/xml в качестве структуры ответа. Подробное описание отчета можно найти в параграфе getScheduleByAOCOnDate.