getVehicles
запрос getVehicles
Для получения списка машин API использует структуру application/x-www-form-urlencoded и HTTP-метод POST
Входные данные запроса getVehicles
Входные данные должны отправляться как атрибуты и не должны находиться в теле запроса. Список всех поддерживаемых атрибутов представлен ниже.
# | Название атрибута | Тип | Стиль | Обязательность | Описание |
1 | sessionID | Текст | Да | Идентификатор сессии, полученный от сервера после запроса авторизации. Срок жизни сессии – 5 минут.. Если в течении этого времени в рамках сессии были проведены запросы, то срок жизни сессии увеличивается еще на 5 минут | |
2 | date | Дата | Query | Да | Запрашиваемая дата. Формат зависит от локализации в конфигурации аккаунта. Например, для Англии формат – “DD/MM/YYYY”. Для России – “ДД.MM.ГГГГ” |
Пример запроса getVehicles
Заголовки:
Метод: POST.
URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/getVehicles?sessionID=eca3b9f1afa24988834ceb5c6aafdcbf&date=28.01.2014
Структура: application/x-www-form-urlencoded.
Тело запроса: не должно содержать никакой информации.
Ответ getVehicles
Для получения списка машин API использует структуру application/xml в качестве структуры ответа.
Выходные данные для ответа getVehicles
# | Название поля | Описание |
1 | vehiclesResponse | |
1.1 | units | |
| Атрибут “timeZone” | Часовой пояс аккаунта |
| Атрибут “timeZoneOffset” | Смещение часового пояса аккаунта | |
| Атрибут “currency” | Валюта аккаунта |
| Атрибут “distanceUnits” | Единицы измерения расстояния аккаунта |
| Атрибут “speedUnits” | Единицы измерения скорости аккаунта | |
| Атрибут “durationUnits” | Единицы измерения времени аккаунта |
| Атрибут “weightUnits” | Единицы измерения веса аккаунта |
Атрибут “volumeUnits” | Единицы измерения объема аккаунта (если настроено) | |
1.2 | vehicles | |
1.2.1 | vehicle | |
| Атрибут “id” | Идентификатор машины в аккаунте, который может быть использован в дальнейших запросах |
| Атрибут “name” | Имя машины |
| Атрибут "externalID" | Внешний идентификатор машины | |
| Атрибут “active” | Показывает является ли активной текущая машина. Возможные значения:
|
| Атрибут “driverName” | Имя водителя |
| Атрибут “costByDistanceUnit” | Стоимость за милю/километр, значение зависит от единиц, выбранных в “currency” |
| Атрибут "vehicleActivationCost" | Фиксированная стоимость использования определенной машины. Эта стоимость используется, чтобы отразить стоимость выхода машины в работу или зарплату водителя за день. | |
| Атрибут "costPerOrder" | Данный параметр отражает стоимость выполнения одного заказа определенной машиной. | |
| Атрибут “maxWeight” | Грузоподъемность транспортного средства, значение зависит от единиц, выбранных в “weightUnits” |
| Атрибут “maxVolume” | Объем транспортного средства, значение зависит от единиц, выбранный в "volumeUnits" (если настроено) | |
| Атрибут “availabilityStartTime” | Время начала доступности водителя |
| Атрибут “availabilityEndTime” | Время окончания доступности водителя |
| Атрибут “aocId” | Идентификатор распределительного центра, которому принадлежит машина |
| Атрибут “vehicleRequirements” | Список типов заказов, которые совместимы с данным транспортным средством. |
| Атрибут “scheduleZonesId” | Список зон планирования, которые могут обслуживаться данным транспортным средством. |
Пример ответа getVehicles
<?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КМ" externalID="A584KM" 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ТЕ" externalID="vehicle02" 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>