importVehicles

Owned by Former user (Deleted)
Last updated: Jun 16, 2022 by Admin Doc Maxoptra


запрос importVehicles

Запрос используется для импорта автомобилей в систему. Для импорта автомобилей по API используется структура application/xml и HTTP-метод POST. 

URL: [account-name].maxoptra.com/rest/2/distribution-api/objects/importVehicles


Список поддерживаемых атрибутов:

№Наименование поляТипДлинаОбязательностьПримерыОписание
1vehicle



Блок информации об автомобиле
1.1nameТекст255ДаО890НАИмя автомобиля
1.2vehicleTypeТекст255НетТранзитТип транспортного средства. См.Типы транспортных средств.
1.3externalIdТекст255НетО890НАВнешний идентификатор автомобиля
1.4activeЛогическоеtrue / falseНет

Признак того что машина должна быть доступна для планирования, возможные значения:

  • true (по умолчанию) - Означает, что в настройках машины включена опция “Использовать в последнюю очередь” (см. Параметры машины). Машина будет всегда доступна для планирования.
  • false - Означает, что в настройках машины включена опция “Использовать в последнюю очередь” (см. Параметры машины). Машина не будет доступна для планирования.
1.5suspended Логическоеtrue / falseНет

 Признак того что машина не используется в аккаунте, возможные значения:

  • true (опция “Архивная” включена)
  • false (опция “Архивная” выключена) - по умолчанию
1.6costByDistance Текст255Да50.00Стоимость одной единицы пробега: мили или километры, в зависимости от аккаунта
1.7maxWeight Число255Да*1000Максимальная вместимость машины для используемой в аккаунте первой единицы измерения заказа (вес), зависит от конфигурации аккаунта. Параметр обязателен если он включен в аккаунте.
1.8maxVolumeЧисло255Да*100Максимальная вместимость машины для используемой в аккаунте второй единицы измерения заказа (объём), зависит от конфигурации аккаунта. Параметр обязателен если он включен в аккаунте.
1.9averageSpeed Число255Нет120Максимально допустимая скорость для данной машины
1.10deviceCodeТекст255Нет3735020212Идентификатор установленного/используемого в данной машине GPS трекера
1.11deviceTypeТекст255НетTomTomТип устройства. Значения: TomTom, Wialon, Autotracker
1.12colorТекст255Нет
Цвет машины который будет виден на экране планирования при построении маршрутов
1.13manufacturerInfoТекст255НетLada GrantaИнформация о производителе
1.14vinТекст255Нет1HFSC3404VA000123Заводской номер автомобиля
1.15vehicleActivationCostТекст255Нет1200.00Фиксированная стоимость использования определенной машины. Эта стоимость используется, чтобы отразить стоимость выхода машины в работу или зарплату водителя за день. В фоме машины указана в строке "Цена машины".
1.16costPerOrderТекст255Нет100.00Данный параметр отражает стоимость выполнения одного заказа определенной машиной.
1.17comments Текст255НетТехосмотр в маеКомментарии
1.18allowSpeedCorrectionFactorЛогическоеtrue / falseНет

Признак использования для данной машины индивидуальных настроек корректирующего коэффициента вождения, возможные значения:

  • true (иcпользуется)
  • false (не используется)
1.19speedCorrectionFactorЧисло255Нет0.3Значение корректирующего коэффициента вождения
1.20runDistanceLimitЧисло255Нет150Максимальная протяженность рейса. Значение указывается в единицах расстояния аккаунта (для России - километры). Незаполненное поле означает отсутствие ограничений.
1.21areaOfControlТекст255ДаНогинскНазвание распределительного центра, которому принадлежит автомобиль
2vehicleRequirements



Блок информации о поддерживаемых требованиях к транспортному средству
2.1nameТекст255Дазагрузка сзадиНаименование поддерживаемых требований к транспортному средству
2.2abbreviationТекст4НетЗСАббревиатура поддерживаемых требований к транспортному средству
3zone

Нет
Блок, в котором указывается территория (зона обслуживания), на которой может работать автомобиль
3.1nameТекст255нетАНазвание территории (зоны обслуживания)


Метод importVehicles ищет машину по externalID (если внешний идентификатор был указан в запросе). Если нет, то продолжает искать по имени и по AOC, а, найдя, обновляет значения всех полей. Если ничего не было найдено, в системе создается новая машина.

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

<?xml version="1.0" encoding="UTF-8"?>
<apiRequest>
   <sessionID>da115466cfd04b10a87766c36b4bf25b</sessionID>
   <vehiclesDetails>
      <units />
      <vehicles>
         <vehicle name="Test_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="Ногинск">
            <vehicleRequirements>
               <vehicleRequirement name="Загрузка сбоку" abbreviation="Б" />
               <vehicleRequirement name="Охлажденка" abbreviation="Ф" />
            </vehicleRequirements>
            <zones>
               <zone name="Center" />
            </zones>
         </vehicle>
      </vehicles>
   </vehiclesDetails>
</apiRequest>


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

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">
   <objects>
      <updatedObject>
         <name>Vehicle_API_1052628</name>
      </updatedObject>
   </objects>
</apiResponse>