Структура "Машина" [1.1]

Описание

Здесь вы сможете найти описание основных параметров структуры "Машина".

Вложенные структуры

Структура "Transport"

Представляет собой структуру, описывающую основные характеристики кузова.

Название
Тип
Описание
Особые значения
Обязательный
car_typeintИдентификатор кузова.Значение из словаря, поле TypeId.+
loading_typeintБитовая сумма id типов загрузки машины. Например: только "Верхняя" будет иметь значение 1; "Верхняя", "Боковая" и "Со снятием стоек" имеют значение 67 (1 + 2 + 64).Битовая сумма значений из словаря. 
weight
floatМаксимальный вес перевозки в тоннах.Обязательный параметр. Больше 0. Максимальная длина - 4 символа+
volumefloatОбъем кузова в кубических метрах.Обязательный параметр. Больше 0.Максимальная длина - 4 символа.+
truck_lengthfloatДлина кузова в метрах.Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0. 
truck_widthfloatШирина кузова в метрах.Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0. 
truck_heightfloatВысота кузова в метрах.Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0. 
partial_loadboolПараметр, определяющий, возможен ли догруз.По умолчанию - false. 
hydrolift
boolПараметр, определяющий, имеется ли в кузове гидролифт.По умолчанию - false. 
konikiboolОпределяет, присутствуют ли коники.По умолчанию - false. 
body_typeintОписывает тип самого грузового автомобиля: грузовик, прицеп или сцепка.
  • 1 – грузовик;
  • 2 – полуприцеп;
  • 4 – сцепка.
+
trailer_lengthfloatДлина прицепа в метрах.

Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0. Должен принимать значение 0 или отсутствовать, если body_type != 4.

 
trailer_widthfloatШирина прицепа в метрах.Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0. Должен принимать значение 0 или отсутствовать, если body_type != 4. 
trailer_heightfloatВысота прицепа в метрах.Допустимое значение от 0 до 50. Максимальная длина - 5 символов. По умолчанию - 0.Должен принимать значение 0 или отсутствовать, если body_type != 4. 
tirboolПараметр, определяющий, имеются ли у машины документы TIR.По умолчанию - false. 
ekmtboolПараметр, определяющий, имеются ли у машины документы EKMT.По умолчанию - false. 
adrintПараметр, определяющий уровень опасности грузов, которые можно провозить на данной машине.Допустимое значение от 0 до 9. По умолчанию - 0. 
adr_typesintПараметр, определяющий уровни опасности грузов, которые можно провозить на данной машине.Допустимое значение от 0 до 511.

Структура "Loading" 

Описывает маршрут, по которому пойдет машина.

Название
Тип
Описание
Особые значения
Обязательный
Примечание для разработчика ATI
city_idintИдентификатор города загрузки.

Значение из словаря.

+CityId – в базе. В загрузке можно указать только город, после страна и регион высчитываются автоматически.
radiusintРадиус, в котором машина может быть загружена, в км.Должен принимать значения от 0 до 999. По умолчанию равен 0.  

 

Структура "Unloading" 

Описывает маршрут, по которому пойдет машина.

Название
Тип
Описание
Особые значения
Обязательный
point_typeintОпределяет в какой точке будет производиться разгрузка
  • 2 – город (по умолчанию);
  • 1 – регион;
  • 0 – страна.
 
point_idintИдентификатор точки разгрузки.
 

Значение из словаря. 
если параметр point_type равен 2, выбирается id из словаря городов;
если параметр point_type равен 1, выбирается id из словаря регионов;
если параметр point_type равен 0, выбирается id из словаря стран.

+
radiusintРадиус, в котором машина может быть разгружена, в км.Должен принимать значения от 0 до 999. По умолчанию равен 0. Должен быть равен 0 или отсутствовать, если параметр point_type не равен 2. 
additional_points
массив структур
AdditionalUnloadingPoint
Дополнительные возможные пункты разгрузкиПо умолчанию массив пуст. 

Структура "AdditionalUnloadingPoint"

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

Название
Тип
Описание
Особые значения
Обязательный
point_typeintОпределяет в какой точке будет производиться загрузка
  • 2 – город (по умолчанию);
  • 1 – регион;
  • 0 – страна.
+
point_idintИдентификатор точки загрузки.
 

Значение из словаря. 
если параметр point_type равен 2, выбирается id из словаря городов;
если параметр point_type равен 1, выбирается id из словаря регионов;
если параметр point_type равен 0, выбирается id из словаря стран.

+
radiusintРадиус, в котором машина может быть разгружена, в км.Должен принимать значения от 0 до 999. По умолчанию равен 0. Должен быть равен 0 или отсутствовать, если параметр point_type не равен 2. 
rate_sumintСтавка для перевозки.Максимальная длина 6 символов. 
currency_idintИдентификатор валюты.Если указан rate_sum, то Значение из словаря. По умолчанию -- 1. Если не указан rate_sum, должен быть равен 0.+/-
money_typeintТип ставки
Ничего = 0,
Nal = 1,
Nds = 2,
WithoutNds = 3
-

 

 

 

Структура "Priority"

Описывает настройки приоритетного показа для машины.

Название
Тип
Описание
Особые значения
Обязательный
daily_limitfloatСуточный лимит списания по услуге.
  • должен иметь не более 2 значащих цифр после запятой;
  • не более 8 символов в длину;
  • должен быть больше либо равен значению view_rate или быть равным нулю (если ограничения нет);
  • должен быть равен 0 или отсутствовать, если параметр view_rate отсутствует или равен 0.
 
is_for_payed_onlyboolПоказывать приоритетный показ только платным пользователям.  
order_limitfloatЛимит на заявку.
  • должен иметь не более 2 значащих цифр после запятой;
  • не более 8 символов в длину;
  • должен быть больше либо равен значению view_rate или быть равным нулю (если ограничения нет);
  • должен быть равен 0 или отсутствовать, если параметр view_rate отсутствует или равен 0.
 
view_ratefloatСтавка за просмотр.
  • минимальное значение 0,3;
  • максимальное – текущий баланс;
  • должен иметь не более 2 значащих цифр после запятой;
+(если структура Priority не равна null)/-
money_spent_per_dayfloatДеньги потраченные на машину за день. Только для чтения.  
money_spent_per_orderfloatДеньги потраченные на машину за заявку. Только для чтения.  

 

Структура "Payment"

Описывает настройки оплаты для машины.

Название
Тип
Описание
Особые значения
Обязательный
cash_sumfloatСтавка для перевозки. Со способом оплаты наличными или картой (nal, card)

Максимальная длина 6 символов. Не более 2 знаков после запятой. По умолчанию 0.

Если ставка › 0,  должно быть card = true и/или nal = true

 +/-
currency_idintИдентификатор валюты.Если указан cash_sum, sum_with_nds, sum_without_nds то Значение из словаря. По умолчанию -- 1. Если не указана ни одна из ставок, должен быть равен 0.+/-
sum_with_ndsfloatСтавка для перевозки, с безналичным расчетом и НДС

Максимальная длина 6 символов. Не более 2 знаков после запятой. По умолчанию 0.

+/-
sum_without_ndsfloatСтавка для перевозки, с безналичным расчетом, без НДСМаксимальная длина 6 символов. Не более 2 знаков после запятой. По умолчанию 0.+/-
cardboolПараметр, определяющий, что возможен перевод на карту.

По умолчанию – false.

Должно быть card = true и/или nal = true , если указана ставка cash_sum

+/-
torgboolПараметр, определяющий, что возможен торг

По умолчанию – true.

Может быть true если указана одна из ставок cash_sum, sum_with_nds, sum_without_nds

При добавлении машины без ставок ставится принудительно torg=true


Список параметров

Название
Тип
Описание
Особые значения
Обязательный
truck_id
guidИдентификатор машиныТолько для чтения. 
firm_idstringИдентификатор фирмыТолько для чтения. 
contact_id1intИдентификатор первого выбранного контактаДолжен присутствовать в фирме и быть видимым контактом.+
contact_id2int?Идентификатор второго выбранного контакта, если не выбрано, то nullМожет иметь значение null. Иначе должен присутствовать в фирме и быть видимым контактом. 
notestringПримечание к машинеОграничение по длине: 250 символов. 
updated_atdateTimeДата последнего изменения данных машины в формате UTCТолько для чтения. 
added_atdateTimeВремя добавления данных машины в формате UTCТолько для чтения. 
archived_atdateTimeВремя архивирования груза в формате UTCТолько для чтения, показывается только в архивных машинах. 
first_datedateДата, начиная с которой машина актуальна, UTC

Минимальное значение равно текущей дате.

  • При значении параметра date_type равным 0, значение может быть произвольным или отсутствовать автоматически проставляется текущая дата;
  • При значении параметра date_type равным 1, допустимое значение поля - от текущей даты до 60 дней вперед;
  • При значении параметра date_type равным 2, значение может быть произвольным или отсутствовать автоматически проставляется текущая дата;
+/-
last_datedateДата, после которой машина не актуальна, в формате UTC.

Минимальное значение равно значению параметра FirstDate.

  • При значении параметра date_type равным 0, значение может быть произвольным или отсутствовать автоматически проставляется текущая дата + 2 дня.
  • При значении параметра date_type равным 1, допустимое значение поля - от даты в параметре first_date до 9 дней вперед;
  • При значении параметра date_type равным 2, значение может быть произвольным или отсутствовать автоматически проставляется текущая дата + 60 дней.
+/-
date_typeintВыбор типа готовности машины к перевозке.
  • 0 - готов к загрузке;
  • 1 - с Х по У;
  • 2 - постоянно;
+
periodicity_idintПериодичность загрузки.

Если параметр date_type не равен 2, periodicity_id должен быть равен 0 или отсутствовать. Иначе periodicity_id может принимать следующие значения:

  • 0 – не выбрано;
  • 1 -- ежедневно;
  • 5 – 2 раза в неделю;
  • 10 – еженедельно;
  • 20 – ежемесячно;
  • 40 – часто;
  • 50 – по согласию;
  • 100 - по рабочим дням.
+/-
true_pricefloatОзвученная ставка для машины. Проставляется в случае, если 2 и более пользователей укажут одну и ту же озвученную ставку для машины. Только для чтения.  
true_currency_idintId озвученной ставки для машины. Только для чтения.  
transportTransportСтруктура "Transport" +
loadingLoadingСтруктура "Loading" +
unloadingUnloadingСтруктура "Unloading" +
paymentPaymentСтруктура "Payment"  
priorityPriorityСтруктура "Priority"