запрос exportVehicles
Запрос используется для экспорта автомобилей из системы.
Метод: POST
URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/exportVehicles
Список поддерживаемых атрибутов:
| № | Наименование поля | Обязательность | Описание |
| 1 | vehicle |
|
| Блок информации об автомобиле |
| 1.1 | id | Да | Идентификатор машины в аккаунте, который может быть использован в дальнейших вопросах |
| 1.2 | name | Да | Имя автомобиля |
| 1. |
2| 3 | externalID | Нет | Внешний идентификатор |
водителя| автомобиля. Поле выгружается только в том случае, если оно было заполнено при создании автомобиля |
| 1. |
2| 3 | active | Да | Включен или нет |
| 1. |
3| 4 | suspended | Да | Заблокирован или нет |
| 1. |
4| 5 | costByDistance | Да | Цена за милю |
| 1.6 | vehicleActivationCost | Да | Фиксированная стоимость использования определенной машины. Эта стоимость используется, чтобы отразить стоимость выхода машины в работу или зарплату водителя за день. |
| 1.7 | costPerOrder | Да | Данный параметр отражает стоимость выполнения одного заказа определенной машиной. |
| 1. |
5| 8 | maxWeight | Да | Максимальная вместимость машины для используемой в аккаунте первой единицы измерения заказа (вес) |
| 1. |
6| 9 | maxVolume | Да | Максимальная вместимость машины для используемой в аккаунте второй единицы измерения заказа (объём) |
| 1. |
7| 10 | averageSpeed | Да | Максимальная скорость |
| 1. |
8| 11 | deviceCode | Нет | Код устройства |
| 1. |
9| 12 | deviceType | Нет | Тип устройства. Значения: TomTom, Wialon, Autotracker |
| 1. |
1011| 14 | manufacturerInfo | Нет | Информация о производителе |
| 1. |
12| 15 | vin | Нет | Заводской номер автомобиля |
| 1. |
13| 16 | comments | Нет | Комментарии |
| 1. |
14| 17 | allowSpeedCorrectionFactor | Нет | Корректирующий коэффициент: включен, выключен. Значения: true / false. |
| 1. |
15| 18 | speedCorrectionFactor | Нет | Значение корректирующего коэффициента |
| 1.19 | runDistanceLimit | Нет | Максимальная протяженность рейса. Значение указывается в единицах расстояния аккаунта (для России - километры). Незаполненное поле означает отсутствие ограничений. |
| 1. |
16| 20 | areaOfControl | Да | Распределительный центр |
| 2 | vehicleRequirements | Нет | Блок информации о поддерживаемых требованиях к транспортному средству |
| 2.1 | name | Да | Наименование поддерживаемых требований к транспортному средству |
| 2.2 | abbreviation |
Да| Нет | Аббревиатура поддерживаемых требований к транспортному средству |
| 3 | units |
|
| Блок со значениями единиц измерений |
| 3.1 | timeZone | Нет | Таймзона |
| 3.2 | timeZoneOffset | Да | Часовой пояс |
| 3.3 | currency | Да | Валюта |
| 3.4 | distanceUnits | Да | Единицы измерения расстояния |
| 3.5 | speedUnits | Да | Единицы измерения скорости. Значения: METERS_PER_SEC KILOMETERS_PER_HOUR MILES_PER_HOUR. |
| 3.6 | durationUnits | Да | Единицы измерения погрузки |
| 3.7 | weightUnits | Да | Единицы измерения веса |
| 3.8 | volumeUnits | Да | Единицы измерения объема (если настроено) |
| 4 | zone |
|
| Блок, в котором указывается территория, на которой может работать автомобиль |
| 4.1 | name | Да | Название территории |
| 5 | homeLocation |
|
| Блок информации об адресе возврата в конце дня |
| 5.1 | name | Да | Имя |
| 5.2 | address | Да | Адрес |
| 5.3 | latitude | Нет | Широта |
| 5.4 | longitude | Нет | Долгота |
Передает параметр sessionID
URL: /rest/2/distribution-api/objects/exportVehicles?sessionID=c7aea2918df94ec78e86bb0f86098ec8
Пример ответа
| Code Block |
|---|
|
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
<vehiclesDetails>
<units timeZone="Greenwich Mean Time" timeZoneOffset="GMT+0:00" currency="POUNDROUBLE" distanceUnits="MILEKILOMETER" speedUnits="MILESKILOMETERS_PER_HOUR" durationUnits="MINUTE" weightUnits="Kg" />
<vehicles>
<vehicle name="demosupport" externalId="7cc3098028614de3bcc6fb3c468fc986" active="true" suspended="false" costByDistance="1" maxWeight="55" maxVolume="0" averageSpeed="90" color="#937128" allowSpeedCorrectionFactor="false" runDistanceLimit="50,3" areaOfControl="ChippenhamZone">
<homeLocation />
</vehicle>
</vehicles>
</vehiclesDetails>
</apiResponse> |
...