Поиск по сайту

API
Главная / API - Почасовая аренда транспорта

Почасовая аренда транспорта

Обновлено 11.06.2021
222 кб

Общие сведения

Сервис предназначен для формирования заявок на почасовую аренду.

Справочные методы "Условия почасовой аренды (поиск по КЛАДР города)" и "Условия почасовой аренды (поиск по наименованию города)" позволяют:

  1. Определить возможность оказания услуги "Почасовая аренда" в городе. 
  2. Получить список категорий транспортных средств, доступных для заказа.
  3. Получить информацию о дополнительных услугах и их стоимости в разрезе транспортных средств.

Оформление заявки на почасовую аренду

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

Адрес метода: https://api.dellin.ru/v1/customers/request_hr.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "produceDate":"2017-02-20",
   "produceTime":"09:00",
   "derival":{
      "counteragentID":5775755,
      "addressID":4545885
   },
   "arrival":{
      "counteragentID":5353453,
      "addressID":6523423
   },
   "sender":{
      "counteragentID":5775755,
      "contact":3465688,
      "contactList":[
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[
         31234343,
         36456565
      ],
      "data_for_receipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      }
   },
   "receiver":{
      "counteragent_id":5775755,
      "contact":3465688,
      "contactList":[
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[
         31234343,
         36456565
      ],
      "data_for_receipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      }
   },
   "third":{
      "counteragentID":9878696,
      "contact":3465688,
      "contactList":[
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[
         31234343,
         36456565
      ],
      "data_for_receipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      }
   },
   "payer":"third",
   "paymentType":"cash",
   "mailback":"test@mail.ru",
   "smsback":"79214587878",
   "comment":"test test",
   "cargoName":"Запчасти для трактора",
   "packed":"0x9a7f11408f4957d7494570820fcf4549",
   "requester":"5775755",
   "role":"third",
   "noFullAccess":"false",
   "statedValue":100.90,
   "loading":true,
   "unloading":false,
   "forwarder":false,
   "carType":216,
   "manipulator":true,
   "toCenter":true,
   "outerDistance":20.5,
   "hazardClass":1,
   "rentTime":5,
   "removeCover":false
}

Адрес метода: https://api.dellin.ru/v1/customers/request_hr.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <produceDate>2017-02-20</produceDate>
   <produceTime>09:00</produceTime>
   <derival>
      <counteragentID>5775755</counteragentID>
      <addressID>4545885</addressID>
   </derival>
   <arrival>
      <counteragentID>5353453</counteragentID>
      <addressID>6523423</addressID>
   </arrival>
   <sender>
      <counteragentID>5775755</counteragentID>
      <contact>3465688</contact>
      <contactList>12312343</contactList>
      <contactList>54364565</contactList>
      <phone>4656889</phone>
      <phoneNumbers>31234343</phoneNumbers>
      <phoneNumbers>36456565</phoneNumbers>
      <data_for_receipt>
         <phone>+79ХХХХХХХХХ</phone>
         <email>test@mail.ru</email>
      </data_for_receipt>
   </sender>
   <receiver>
      <counteragent_id>5775755</counteragent_id>
      <contact>3465688</contact>
      <contactList>12312343</contactList>
      <contactList>54364565</contactList>
      <phone>4656889</phone>
      <phoneNumbers>31234343</phoneNumbers>
      <phoneNumbers>36456565</phoneNumbers>
      <data_for_receipt>
         <phone>+79ХХХХХХХХХ</phone>
         <email>test@mail.ru</email>
      </data_for_receipt>
   </receiver>
   <third>
      <counteragentID>9878696</counteragentID>
      <contact>3465688</contact>
      <contactList>12312343</contactList>
      <contactList>54364565</contactList>
      <phone>4656889</phone>
      <phoneNumbers>31234343</phoneNumbers>
      <phoneNumbers>36456565</phoneNumbers>
      <data_for_receipt>
         <phone>+79ХХХХХХХХХ</phone>
         <email>test@mail.ru</email>
      </data_for_receipt>
   </third>
   <payer>third</payer>
   <paymentType>cash</paymentType>
   <mailback>test@mail.ru</mailback>
   <smsback>79214587878</smsback>
   <comment>test test</comment>
   <cargoName>Запчасти для трактора</cargoName>
   <packed>0x9a7f11408f4957d7494570820fcf4549</packed>
   <requester>5775755</requester>
   <role>third</role>
   <noFullAccess>false</noFullAccess>
   <statedValue>100.9</statedValue>
   <loading>true</loading>
   <unloading>false</unloading>
   <forwarder>false</forwarder>
   <carType>216</carType>
   <manipulator>true</manipulator>
   <toCenter>true</toCenter>
   <outerDistance>20.5</outerDistance>
   <hazardClass>1</hazardClass>
   <rentTime>5</rentTime>
   <removeCover>false</removeCover>

</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
Основные параметры
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
produceDateДаstring

Дата подачи машины.

Формат: ГГГГ-ММ-ДД

produceTimeДаstring

Время подачи машины.

Формат: ЧЧ:ММ

derivalДаDerivalArrivalОткуда 
arrivalДаDerivalArrivalКуда 
senderДаMemberДанные отправителя
receiverДаMemberДанные получателя
thirdНет*Member

Данные третьего лица.

*Если "payer" = "third", то параметр является обязательным

payerДаstring

Плательщик.

Доступные значения:

  • "sender" - отправитель;
  • "receiver" - получатель;
  • "third" - третье лицо
paymentTypeДаstring

Тип оплаты.

Доступные значения:

  • "cash" - оплата наличными;
  • "non_cash" - безналичная оплата
mailbackНетstringEmail для связи и уведомлений
smsbackНетstring

Телефон для связи и уведомлений по SMS

Формат: 11 цифр с ведущей семеркой ("79999999999")

commentНетstringКомментарий к заказу
cargoNameДаstringХарактер груза
packedДаstringТип имеющейся упаковки груза
requesterНетstring

Заказчик.

UID одного из доступных контрагентов учетной записи ЛК. Может быть получен из метода "Получение списка контрагентов"

roleНетstring

Роль в перевозке.

Доступные значения:

  • "sender" - отправитель;
  • "receiver" - получатель;
  • "payer" - плательщик - доступно, если в учетной записи ЛК есть не менее одного контрагента с полным доступом;
  • "third" - третье лицо - доступно, если в учетной записи ЛК нет контрагентов с полным доступом
noFullAccessНетbooleanОтсутствует полный доступ к контрагентам. Параметр необходимо передать, если у оформителя заявки в учетной записи ЛК нет контрагентов с полным доступом
statedValueНетfloat

Объявленная стоимость.

Значение по умолчанию: "0"

loadingНетboolean

Погрузка в месте подачи.

Значение по умолчанию: "false"

unloadingНетboolean

Разгрузка в месте назначения.

Значение по умолчанию: "false"

forwarderНетboolean

Сопровождение груза.

Доступные значения:

  • "true" - самостоятельное;
  • "false" - экспедирование.

Значение по умолчанию: "true"

carTypeДаinteger

Арендуемая машина

ID категории транспортного средства, полученный при помощи одного из методов - "Условия почасовой аренды (поиск по КЛАДР города)" или метода "Условия почасовой аренды (поиск по наименованию города)"

manipulatorНетbooleanМанипулятор
toCenterНетbooleanВъезд в центр
outerDistanceНетfloatРасстояние за городом, км
hazardClassНетfloat

Класс опасности.

Значение по умолчанию: "0".

Подробнее о классах опасности

rentTimeДаintegerВремя аренды, час
removeCoverНетbooleanРастентовка
Derival

DerivalArrival
ПараметрОбязательныйТипОписание
counteragentIDДаintegerID контрагента. Указывается на основании "Адресной книги"
addressIDДаintegerID адреса. Указывается на основании "Адресной книги"
Member

Member
ПараметрОбязательныйТипОписание
counteragentIDДаintegerID контрагента. Указывается на основании "Адресной книги"
contactДаinteger

ID контактного лица или массив ID контактных лиц. Указывается на основании "Адресной книги".

в запросе должен присутствовать только 1 из параметров

contactListДаarray of integers
phoneДаinteger

ID контактного телефона или Массив ID контактных телефонов. Указывается на основании "Адресной книги".

В запросе должен присутствовать только 1 из параметров

phoneNumbersДаarray of integers
data_for_receiptНетobjectКонтактные данные для отправки электронного чека плательщику-физическому лицу
data_for_receipt.phoneНетstring

Номер телефона для отправки чека.

Формат номера: "+79XXXXXXXXX" (12 символов: начинается с "+79", и далее 9 цифр)

data_for_receipt.emailНетstringEmail адрес для отправки чека

Ответ метода

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

{
   "order_id":7309608,
   "success":true
}
<response>
   <order_id>7309608</order_id>
   <success>true</success>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
order_idintegerНомер заказа
successbooleanПризнак успешности операции

Обработка ошибок

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

Формат ответа API в случае ошибки:

{
   "state":"error",
   "errors":{
      "smsback":"Значение параметра smsback не соответствует формату"
   }
}
<response>
   <state>error</state>
   <errors>
      <smsback>Значение параметра smsback не соответствует формату</smsback>
   </errors>
</response>

Виды ошибок

Ответ метода может содержать следующие специфичные ошибки:

ОшибкаОписание
Не указаны данные третьего лицаВ параметре "payer" передано значение "third", но объект "third" отсутствует в запросе
Значение параметра smsback не соответствует форматуФормат параметра: 11 цифр с ведущей семеркой (79999999999)
Телефон содержит недопустимые символыЗначение параметра не соответствует формату: "+79XXXXXXXXX" (12 символов: начинается с "+79", и далее 9 цифр)"data_for_receipt.phone"
Неверный номер телефона
Некорректное значение параметра "role"
  • В параметре "role" передано значение "payer" И (отсутствует полный доступ к контрагентам ИЛИ в параметре "noFullAccess" передано значение "true")
  • В параметре "role" передано значение "third" И (есть полный доступ к контрагентам ИЛИ в параметре "noFullAccess" передано значение "false")
Недопустимое значение параметра "requester"
  • В параметре "requester"передан UID несуществующего контрагента
  • В аккаунте отсутствуют контрагенты

Условия почасовой аренды (поиск по КЛАДР города)

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/public/request_hr_info.json

{
   "appkey": "00000000-0000-0000-0000-000000000000",
   "city": "7800000000000000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/request_hr_info.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <city>7800000000000000000000000</city>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
cityДаstringКод КЛАДР города. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР"

Ответ метода 

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

{  
   "car_types":[  
      {  
         "city":"Санкт-Петербург",
         "id":98,
         "category":"Тент/Фургон",
         "timeMinimum":4,
         "timeToDelivery":1,
         "hourlyPrice":600,
         "outerDistancePrice":17,
         "manipulator":false,
         "manipulator_price":0,
         "removeCover":true,
         "removeCoverPrice":500,
         "toCenter":false,
         "toCenterPrice":0,
         "tonnage":2000,
         "volume":15,
         "length":4,
         "width":2,
         "height":1.95
      },
      {  
         "city":"Санкт-Петербург",
         "id":143,
         "category":"Фургон",
         "timeMinimum":5,
         "timeToDelivery":1,
         "hourlyPrice":650,
         "outerDistancePrice":23,
         "manipulator":false,
         "manipulator_price":0,
         "removeCover":false,
         "removeCoverPrice":0,
         "toCenter":false,
         "toCenterPrice":0,
         "tonnage":3000,
         "volume":17,
         "length":4,
         "width":2.1000000000000001,
         "height":2.1000000000000001
      }
   ]
}
<response>
   <car_types>
      <city>Санкт-Петербург</city>
      <id>98</id>
      <category>Тент/Фургон</category>
      <timeMinimum>4</timeMinimum>
      <timeToDelivery>1</timeToDelivery>
      <hourlyPrice>600</hourlyPrice>
      <outerDistancePrice>17</outerDistancePrice>
      <manipulator>false</manipulator>
      <manipulator_price>0</manipulator_price>
      <removeCover>true</removeCover>
      <removeCoverPrice>500</removeCoverPrice>
      <toCenter>false</toCenter>
      <toCenterPrice>0</toCenterPrice>
      <tonnage>2000</tonnage>
      <volume>15</volume>
      <length>4</length>
      <width>2</width>
      <height>1.95</height>
   </car_types>
   <car_types>
      <city>Санкт-Петербург</city>
      <id>143</id>
      <category>Фургон</category>
      <timeMinimum>5</timeMinimum>
      <timeToDelivery>1</timeToDelivery>
      <hourlyPrice>650</hourlyPrice>
      <outerDistancePrice>23</outerDistancePrice>
      <manipulator>false</manipulator>
      <manipulator_price>0</manipulator_price>
      <removeCover>false</removeCover>
      <removeCoverPrice>0</removeCoverPrice>
      <toCenter>false</toCenter>
      <toCenterPrice>0</toCenterPrice>
      <tonnage>3000</tonnage>
      <volume>17</volume>
      <length>4</length>
      <width>2.1</width>
      <height>2.1</height>
   </car_types>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
car_typesarray of Car_typesДанные для категории транспортного средства

Car_types
Car_types
ПараметрТипОписание
citystringГород
idintegerID категории транспортного средства. Это значение нужно передавать в параметре "carType" метода "Оформление заявки на почасовую аренду"
categorystring

Наименование категории транспортного средства

Возможные значения:

  • "Борт";
  • "Борт (Манипулятор)";
  • "Тент";
  • "Тент/Фургон";
  • "Фургон"
timeMinimumintegerМинимальное время заказа, ч
timeToDeliveryintegerВремя подачи машины, ч
hourlyPricefloatСтоимость аренды в черте населённого пункта, руб./ч
outerDistancePricefloatСтоимость аренды за городом, руб./км
manipulatorboolean

Флаг, обозначающий, что возможна аренда манипулятора

manipulator_pricefloatСтоимость аренды манипулятора, руб. Если услуга недоступна, то значение параметра равно "0"
removeCoverbooleanФлаг, обозначающий, что возможна рестентовка
removeCoverPricefloatСтоимость растентовки, руб. Если услуга недоступна, то значение параметра равно "0"
toCenterbooleanПризнак изменения стоимости аренды при заезде в центр города
toCenterPricefloatСтоимость аренды при заезде в центр города, руб./ч. Если стоимость не меняется, то значение параметра равно "0"
tonnagefloatГрузоподъёмность транспортного средства, кг (1)
volumefloatОбъём транспортного средства, куб. м (1)
lengthfloatДлина транспортного средства, м (1)
widthfloatШирина транспортного средства, м (1)
heightfloatВысота транспортного средства, м (1)

Примечания:

  1.  Для некоторых видов машин значение этого параметра может быть не определено. В этом случае параметр принимает значение "0"

Обработка ошибок

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

{  
   "answer":{  
      "state":"error",
      "errors":{  
         "city":"Указан некорректный код КЛАДР"
      }
   }
}
<response>
   <answer>
      <state>error</state>
      <errors>
         <city>Указан некорректный код КЛАДР</city>
      </errors>
   </answer>
</response>

Виды ошибок

ОшибкаОписание
Указан некорректный код КЛАДРКод КЛАДР, переданный в параметре "city", отсутствует в "Справочнике населенных пунктов"
В указанном городе услуга не предоставляетсяВ городе, код КЛАДР которого передан в параметре "city", услуга не предоставляется

Условия почасовой аренды (поиск по наименованию города)

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/references/hourly_rent_info.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "city":"Ярославль"
}

Адрес метода: https://api.dellin.ru/v1/references/hourly_rent_info.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <city>Ярославль</city>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
cityНетstringНаименование города или его часть. Минимальная длина строки - 2 символа. Поиск осуществляется с начала строки

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2020-02-19 06:44:04"
   },
   "data":[
      {
         "city":"Ярославль",
         "categoryId":351,
         "category":"Тент",
         "minOrderTime":2.0,
         "vehDeliveryTime":1.0,
         "aroundCity":550.0,
         "kilometerCostOut":15.0,
         "manipulator":false,
         "manipulatorCost":0,
         "tentRemoval":true,
         "tentRemovalCost":1500.0,
         "dropCenter":false,
         "dropCenterCost":0,
         "liftCapacity":2000.0,
         "volume":17.0,
         "lenght":4.0,
         "width":2.1,
         "height":2.1
      },
      {
         "city":"Ярославль",
         "categoryId":352,
         "category":"Тент / Фургон",
         "minOrderTime":3.0,
         "vehDeliveryTime":1.0,
         "aroundCity":950.0,
         "kilometerCostOut":25.0,
         "manipulator":false,
         "manipulatorCost":0,
         "tentRemoval":true,
         "tentRemovalCost":1500.0,
         "dropCenter":false,
         "dropCenterCost":0,
         "liftCapacity":5000.0,
         "volume":37.0,
         "lenght":6.5,
         "width":2.38,
         "height":2.4
      },
      {
         "city":"Ярославль",
         "categoryId":350,
         "category":"Фургон",
         "minOrderTime":2.0,
         "vehDeliveryTime":1.0,
         "aroundCity":550.0,
         "kilometerCostOut":15.0,
         "manipulator":false,
         "manipulatorCost":0,
         "tentRemoval":false,
         "tentRemovalCost":0,
         "dropCenter":false,
         "dropCenterCost":0,
         "liftCapacity":2000.0,
         "volume":17.0,
         "lenght":4.0,
         "width":2.1,
         "height":2.1
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2020-02-19 06:44:04</generated_at>
   </metadata>
   <data>
      <city>Ярославль</city>
      <categoryId>351</categoryId>
      <category>Тент</category>
      <minOrderTime>2</minOrderTime>
      <vehDeliveryTime>1</vehDeliveryTime>
      <aroundCity>550</aroundCity>
      <kilometerCostOut>15</kilometerCostOut>
      <manipulator>false</manipulator>
      <manipulatorCost>0</manipulatorCost>
      <tentRemoval>true</tentRemoval>
      <tentRemovalCost>1500</tentRemovalCost>
      <dropCenter>false</dropCenter>
      <dropCenterCost>0</dropCenterCost>
      <liftCapacity>2000</liftCapacity>
      <volume>17</volume>
      <lenght>4</lenght>
      <width>2.1</width>
      <height>2.1</height>
   </data>
   <data>
      <city>Ярославль</city>
      <categoryId>352</categoryId>
      <category>Тент / Фургон</category>
      <minOrderTime>3</minOrderTime>
      <vehDeliveryTime>1</vehDeliveryTime>
      <aroundCity>950</aroundCity>
      <kilometerCostOut>25</kilometerCostOut>
      <manipulator>false</manipulator>
      <manipulatorCost>0</manipulatorCost>
      <tentRemoval>true</tentRemoval>
      <tentRemovalCost>1500</tentRemovalCost>
      <dropCenter>false</dropCenter>
      <dropCenterCost>0</dropCenterCost>
      <liftCapacity>5000</liftCapacity>
      <volume>37</volume>
      <lenght>6.5</lenght>
      <width>2.38</width>
      <height>2.4</height>
   </data>
   <data>
      <city>Ярославль</city>
      <categoryId>350</categoryId>
      <category>Фургон</category>
      <minOrderTime>2</minOrderTime>
      <vehDeliveryTime>1</vehDeliveryTime>
      <aroundCity>550</aroundCity>
      <kilometerCostOut>15</kilometerCostOut>
      <manipulator>false</manipulator>
      <manipulatorCost>0</manipulatorCost>
      <tentRemoval>false</tentRemoval>
      <tentRemovalCost>0</tentRemovalCost>
      <dropCenter>false</dropCenter>
      <dropCenterCost>0</dropCenterCost>
      <liftCapacity>2000</liftCapacity>
      <volume>17</volume>
      <lenght>4</lenght>
      <width>2.1</width>
      <height>2.1</height>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataИнформация для заказа почасовой аренды
data.citystring

Город

data.categoryIdinteger

ID категории транспортного средства. Это значение нужно передавать в параметре "carType" метода "Оформление заявки на почасовую аренду"

data.categorystring

Наименование категории транспортного средства

Возможные значения:

  • "Борт";
  • "Борт (Манипулятор)";
  • "Тент";
  • "Тент/Фургон";
  • "Фургон"
data.minOrderTimefloatМинимальное время заказа, ч
data.vehDeliveryTimefloatВремя подачи машины, ч
data.aroundCityfloatСтоимость аренды в черте населённого пункта, руб./ч
data.kilometerCostOutfloatСтоимость аренды за городом, руб./км
data.manipulatorbooleanФлаг, обозначающий, что возможна аренда манипулятора
data.manipulatorCostfloatСтоимость аренды манипулятора, руб. Если услуга недоступна, то значение параметра равно "0"
data.tentRemovalbooleanФлаг, обозначающий, что возможна рестентовка
data.tentRemovalCostfloatСтоимость растентовки, руб. Если услуга недоступна, то значение параметра равно "0"
data.dropCenterbooleanПризнак изменения стоимости аренды при заезде в центр города
data.dropCenterCostfloatСтоимость аренды при заезде в центр города, руб./ч. Если стоимость не меняется, то значение параметра равно "0"
data.liftCapacityfloatГрузоподъёмность транспортного средства, кг (1)
data.volumefloat
Объём транспортного средства, куб. м (1)
data.lengthfloatДлина транспортного средства, м (1)
data.widthfloatШирина транспортного средства, м (1)
data.heightfloatВысота транспортного средства, м (1)

Примечания:

  1.  Для некоторых видов машин значение этого параметра может быть не определено. В этом случае параметр принимает значение "0"

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".