...
...
запрос importVehicles
Запрос используется для импорта автомобилей в систему. Для импорта автомобилей по API используется структура application/xml и HTTP-метод POST.
...
№ | Наименование поля | Тип | Длина | Обязательность | Примеры | Описание |
1 | vehicle | Блок информации об автомобиле | ||||
1.1 | name | Текст | 255 | Да | О890НА | Имя автомобиля |
1.2 | vehicleType | Текст | 255 | Нет | Транзит | Тип транспортного средства. См.Типы транспортных средств. |
1.3 | externalId | Текст | 255 | Нет | О890НА | Внешний идентификатор автомобиля |
1.34 | active | Логическое | true / false | Нет | Признак того что машина должна быть доступна для планирования, возможные значения:
| |
1.45 | suspended | Логическое | true / false | Нет | Признак того что машина не используется в аккаунте, возможные значения:
| |
1.56 | costByDistance | Текст | 255 | Да | 50.00 | Стоимость одной единицы пробега: мили или километры, в зависимости от аккаунта |
1.67 | maxWeight | Число | 255 | Да* | 1000 | Максимальная вместимость машины для используемой в аккаунте первой единицы измерения заказа (вес), зависит от конфигурации аккаунта. Параметр обязателен если он включен в аккаунте. |
1.78 | maxVolume | Число | 255 | Да* | 100 | Максимальная вместимость машины для используемой в аккаунте второй единицы измерения заказа (объём), зависит от конфигурации аккаунта. Параметр обязателен если он включен в аккаунте. |
1.89 | averageSpeed | Число | 255 | Нет | 120 | Максимально допустимая скорость для данной машины |
1.910 | deviceCode | Текст | 255 | Нет | 3735020212 | Идентификатор установленного/используемого в данной машине GPS трекера |
1.1011 | deviceType | Текст | 255 | Нет | TomTom | Тип устройства. Значения: TomTom, Wialon, Autotracker |
1.1112 | color | Текст | 255 | Нет | Цвет машины который будет виден на экране планирования при построении маршрутов | |
1.1213 | manufacturerInfo | Текст | 255 | Нет | Lada Granta | Информация о производителе |
1.1314 | vin | Текст | 255 | Нет | 1HFSC3404VA000123 | Заводской номер автомобиля |
1.1415 | vehicleActivationCost | Текст | 255 | Нет | 1200.00 | Фиксированная стоимость использования определенной машины. Эта стоимость используется, чтобы отразить стоимость выхода машины в работу или зарплату водителя за день. В фоме машины указана в строке "Цена машины". |
1.1516 | costPerOrder | Текст | 255 | Нет | 100.00 | Данный параметр отражает стоимость выполнения одного заказа определенной машиной. |
1.1617 | comments | Текст | 255 | Нет | Техосмотр в мае | Комментарии |
1.1718 | allowSpeedCorrectionFactor | Логическое | true / false | Нет | Признак использования для данной машины индивидуальных настроек корректирующего коэффициента вождения, возможные значения:
| |
1.1819 | speedCorrectionFactor | Число | 255 | Нет | 0.3 | Значение корректирующего коэффициента вождения |
1.1920 | runDistanceLimit | Число | 255 | Нет | 150 | Максимальная протяженность рейса. Значение указывается в единицах расстояния аккаунта (для России - километры). Незаполненное поле означает отсутствие ограничений. |
1.2021 | areaOfControl | Текст | 255 | Да | Ногинск | Название распределительного центра, которому принадлежит автомобиль |
2 | vehicleRequirements | Блок информации о поддерживаемых требованиях к транспортному средству | ||||
2.1 | name | Текст | 255 | Да | загрузка сзади | Наименование поддерживаемых требований к транспортному средству |
2.2 | abbreviation | Текст | 4 | Нет | ЗС | Аббревиатура поддерживаемых требований к транспортному средству |
3 | zone | Нет | Блок, в котором указывается территория (зона обслуживания), на которой может работать автомобиль | |||
3.1 | name | Текст | 255 | нет | А | Название территории (зоны обслуживания) |
Метод importVehicles ищет машину по externalID (если внешний идентификатор был указан в запросе). Если нет, то продолжает искать по имени и по AOC, а, найдя, обновляет значения всех полей. Если ничего не было найдено, в системе создается новая машина.
Пример запроса:
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <apiRequest> <sessionID>da115466cfd04b10a87766c36b4bf25b</sessionID> <vehiclesDetails> <units /> <vehicles> <vehicle name="Vehicle_APITest_1052628" vehicleType="Легковой автомобиль" active="true" suspended="false" costByDistance="0.17" maxWeight="1051" averageSpeed="127" deviceCode="" deviceType="" color="#772A2A" manufacturerInfo="1" vin="2" vehicleActivationCost="333" costPerOrder="3" comments="api_vehicle" allowSpeedCorrectionFactor="false" speedCorrectionFactor="1" runDistanceLimit="50,3" areaOfControl="chippenhamzoneНогинск"> <vehicleRequirements> <vehicleRequirement name="БольшаяЗагрузка машинасбоку" abbreviation="Б" /> <vehicleRequirement name="ФургонОхлажденка" abbreviation="Ф" /> </vehicleRequirements> <zones> <zone name="Center" /> </zones> </vehicle> </vehicles> </vehiclesDetails> </apiRequest> |
...