Versions Compared

Key

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

запрос

...

getVehiclesByAoc

Для получения списка машин в рамках одного распределительного центра (области контроля) API использует структуру application/x-www-form-urlencoded l и HTTP-запрос POST.

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

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

#

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

Тип

Стиль

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

Описание

1

sessionID

Текст

 

Да

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

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

2

aocID

Целое число

Query

Да

Идентификатор распределительного центра в приложении

3

date

Дата

Query

Да

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

  

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

Заголовки:

URL: /rest/2/distribution-api/objects/getVehiclesByAOCgetVehiclesByAoc?sessionID=eca3b9f1afa24988834ceb5c6aafdcbf&aocID=101&date=28/01/2014

...

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

ответ

...

getVehiclesByAoc

Для получения списка машин в рамках одного распределительного центра (области контроля) API использует структуру application/xml как структуру ответа.

 

Выходные данные ответа getVehiclesByAOCgetVehiclesByAoc

#

Название поля

Описание

1

vehiclesResponse

 

1.1

units

 

 

Атрибут “timeZone”

Часовой пояс аккаунта

 

Атрибут “currency”

Валюта аккаунта

 

Атрибут “distanceUnits”

Единицы измерения расстояния аккаунта

 

Атрибут “durationUnits”

Единицы измерения времени аккаунта

 

Атрибут “weightUnits”

Единицы измерения веса аккаунта

1.2

vehicles

 

1.2.1

vehicle

 

 

Атрибут “id”

Идентификатор машины в аккаунте, который может быть использован в дальнейших вопросах

 

Атрибут “name”

Имя машины

 

Атрибут “active”

Показывает является ли активной текущая машина. Возможные значения:

  • True – машина активна
  • False – машина не активна

 

Атрибут “driverName”

Имя водителя

 

Атрибут “costByDistance”

Стоимость за милю/километр, значение зависит от единиц, выбранных в “currency”

 

Атрибут “maxWeight”

Грузоподъемность транспортного средства, значение зависит от единиц, выбранных в “weightUnits”

 

Атрибут “availabilityStartTime”

Время начала доступности водителя

 

Атрибут “availabilityEndTime”

Время окончания доступности водителя

 

Атрибут “aocId”

Идентификатор распределительного центра, которому принадлежит машина

 

Атрибут “vehicleRequirements”

Список типов заказов, которые совместимы с данным транспортным средством.

 

Атрибут “scheduleZonesId”

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

 

Пример ответа getVehiclesByAOCgetVehiclesByAoc

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
   <vehiclesResponse>
      <units timeZone="GMT+06:00" timeZoneOffset="GMT+6:00" currency="ROUBLE" distanceUnits="KILOMETRE" speedUnits="KILOMETERS_PER_HOUR" durationUnits="MINUTE" weightUnits="кг" />
      <vehicles>
         <vehicle id="7057" name="А584КМ" active="true" driverName="Водитель А584КМ" costByDistance="11" maxWeight="1500" availabilityStartTime="12.10.2014 06:00" availabilityEndTime="12.10.2014 21:00" aocId="337" vehicleRequirements="Truck1 (T), Side-loading (S)" scheduleZonesId="42, 43" />
         <vehicle id="7142" name="А003ТЕ" active="true" driverName=" Водитель А003ТЕ" costByDistance="14" maxWeight="5000" availabilityStartTime="12.10.2014 06:00" availabilityEndTime="12.10.2014 21:00" aocId="337" vehicleRequirements="Truck1 (T), Side-loading (S)" scheduleZonesId="36, 37" />
      </vehicles>
   </vehiclesResponse>
</apiResponse>

...