Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


запрос exportVehicles

Запрос используется для экспорта автомобилей из системы.

Метод: POST

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


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

Наименование поля
Обязательно
ОбязательностьОписание
1vehicle
 

Блок информации об автомобиле
1.1idДаИдентификатор машины в аккаунте, который может быть использован в дальнейших вопросах
1.2nameДаИмя автомобиля
1.3externalIDНетВнешний идентификатор автомобиля. Поле выгружается только в том случае, если оно было заполнено при создании автомобиля
1.
2
3activeДаВключен или нет
1.
3
4suspended ДаЗаблокирован или нет
1.
4
5costByDistance ДаЦена за милю
1.5
1.6vehicleActivationCostДаФиксированная стоимость использования определенной машины. Эта стоимость используется, чтобы отразить стоимость выхода машины в работу или зарплату водителя за день.
1.7costPerOrderДаДанный параметр отражает стоимость выполнения одного заказа определенной машиной.
1.8maxWeight Да
Масса
Максимальная вместимость машины для используемой в аккаунте первой единицы измерения заказа (вес)
1.9maxVolumeДаМаксимальная вместимость машины для используемой в аккаунте второй единицы измерения заказа (объём)
1.
6
10averageSpeed ДаМаксимальная скорость
1.
7
11deviceCodeНетКод устройства
1.
8
12deviceTypeНетТип устройства. Значения: TomTom, Wialon, Autotracker
1.
9vehicleRequirementsНетПоддерживаемые требования к транспортному средству1.10
13colorНетЦвет
1.
11
14
manufacterInfo
manufacturerInfoНетИнформация о производителе
1.
12
15vinНетЗаводской номер автомобиля
1.
13
16comments НетКомментарии
1.
14
17allowSpeedCorrectionFactorНетКорректирующий коэффициент: включен, выключен. Значения: true / false.
1.
15
18speedCorrectionFactorНетЗначение корректирующего коэффициента
1.
16
19runDistanceLimitНетМаксимальная протяженность рейса. Значение указывается в единицах расстояния аккаунта (для России - километры). Незаполненное поле означает отсутствие ограничений.
1.20areaOfControlДаРаспределительный центр
2vehicleRequirementsНетБлок информации о поддерживаемых требованиях к транспортному средству
2
Units 
.1nameДаНаименование поддерживаемых требований к транспортному средству
2.2abbreviationНетАббревиатура поддерживаемых требований к транспортному средству
3units
Блок со значениями единиц
измерения
измерений
2
3.1
timezone
timeZone
Да
НетТаймзона
2
3.2timeZoneOffsetДаЧасовой пояс
2
3.3currencyДаВалюта
2
3.4distanceUnitsДаЕдиницы измерения расстояния
2
3.5speedUnitsДаЕдиницы измерения скорости. Значения: METERS_PER_SEC   KILOMETERS_PER_HOUR   MILES_PER_HOUR.
2
3.6durationUnitsДаЕдиницы измерения погрузки
2
3.7weightUnitsДаЕдиницы измерения веса
2
3.8volumeUnitsДаЕдиницы измерения объема
3homeLocation 
(если настроено)
4zone
Блок, в котором указывается территория, на которой может работать автомобиль
4.1nameДаНазвание территории
5homeLocation
Блок информации об адресе возврата в конце дня
3
5.1nameДаИмя
3
5.2addressДаАдрес
3
5.3latitudeНетШирота
3
5.4longitudeНетДолгота

Передает параметр sessionID

URL: /rest/2/distribution-api/objects/exportVehicles?sessionID=c7aea2918df94ec78e86bb0f86098ec8 


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

...

Code Block
language

 

xml
<?xml version="1.0" encoding="UTF-8"?>
<apiResponse version="1.0">

...

   <vehiclesDetails>

...


   <vehiclesDetails>
      <units timeZone="Greenwich Mean Time"

...

 timeZoneOffset="GMT+0:00"

...

 currency="

...

ROUBLE"

...

 distanceUnits="

...

KILOMETER"

...

 speedUnits="

...

KILOMETERS_PER_HOUR"

...

 durationUnits="MINUTE"

...

 weightUnits="Kg"

...

      <vehicles>

...

 />
      <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>

      <vehiclesDetails>

...


            <homeLocation />
         </vehicle>
      </vehicles>
   </vehiclesDetails>
</apiResponse>