запрос exportVehicles
Запрос используется для экспорта автомобилей из системы.
URL: /rest/2/distribution-api/objects/exportVehicles
Список поддерживаемых атрибутов:
№ | Наименование поля | Обязательность | Описание |
1 | vehicle | Блок информации об автомобиле | |
1.1 | name | Да | Имя автомобиля |
1.2 | active | Да | Включен или нет |
1.3 | suspended | Да | Заблокирован или нет |
1.4 | costByDistance | Да | Цена за милю |
1.5 | maxWeight | Да | Масса |
1.6 | maxVolume | Да | Объём |
1.7 | averageSpeed | Да | Максимальная скорость |
1.8 | deviceCode | Нет | Код устройства |
1.9 | deviceType | Нет | Тип устройства. Значения: TomTom, Wialon, Autotracker |
1.10 | vehicleRequirements | Нет | Поддерживаемые требования к транспортному средству |
1.11 | color | Нет | Цвет |
1.12 | manufacturerInfo | Нет | Информация о производителе |
1.13 | vin | Нет | Заводской номер автомобиля |
1.14 | comments | Нет | Комментарии |
1.15 | allowSpeedCorrectionFactor | Нет | Корректирующий коэффициент: включен, выключен. Значения: true / false. |
1.16 | speedCorrectionFactor | Нет | Значение корректирующего коэффициента |
1.17 | areaOfControl | Да | Распределительный центр |
2 | units | Блок со значениями единиц измерений | |
2.1 | timeZone | Нет | Таймзона |
2.2 | timeZoneOffset | Да | Часовой пояс |
2.3 | currency | Да | Валюта |
2.4 | distanceUnits | Да | Единицы измерения расстояния |
2.5 | speedUnits | Да | Единицы измерения скорости. Значения: METERS_PER_SEC KILOMETERS_PER_HOUR MILES_PER_HOUR. |
2.6 | durationUnits | Да | Единицы измерения погрузки |
2.7 | weightUnits | Да | Единицы измерения веса |
2.8 | volumeUnits | Да | Единицы измерения объема |
3 | zone | Блок, в котором указывается территория, на которой может работать автомобиль | |
3.1 | name | Да | Название территории |
4 | homeLocation | Блок информации об адресе возврата в конце дня | |
4.1 | name | Да | Имя |
4.2 | address | Да | Адрес |
4.3 | latitude | Нет | Широта |
4.4 | longitude | Нет | Долгота |
Передает параметр sessionID
URL: /rest/2/distribution-api/objects/exportVehicles?sessionID=c7aea2918df94ec78e86bb0f86098ec8
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <apiResponse version="1.0"> <vehiclesDetails> <units timeZone="Greenwich Mean Time" timeZoneOffset="GMT+0:00" currency="POUND" distanceUnits="MILE" speedUnits="MILES_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" areaOfControl="ChippenhamZone"> <homeLocation /> </vehicle> </vehicles> </vehiclesDetails> </apiResponse>