Почасовая аренда транспорта
Общие сведения
Сервис предназначен для формирования заявок на почасовую аренду.
Справочные методы "Условия почасовой аренды (поиск по КЛАДР города)" и "Условия почасовой аренды (поиск по наименованию города)" позволяют:
- Определить возможность оказания услуги "Почасовая аренда" в городе.
- Получить список категорий транспортных средств, доступных для заказа.
- Получить информацию о дополнительных услугах и их стоимости в разрезе транспортных средств.
Оформление заявки на почасовую аренду
Запрос метода
Структура запроса
Адрес метода: 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 ], "dataForReceipt":{ "phone":"+79ХХХХХХХХХ", "email":"test@mail.ru" } }, "receiver":{ "counteragent_id":5775755, "contact":3465688, "contactList":[ 12312343, 54364565 ], "phone":4656889, "phoneNumbers":[ 31234343, 36456565 ], "dataForReceipt":{ "phone":"+79ХХХХХХХХХ", "email":"test@mail.ru" } }, "third":{ "counteragentID":9878696, "contact":3465688, "contactList":[ 12312343, 54364565 ], "phone":4656889, "phoneNumbers":[ 31234343, 36456565 ], "dataForReceipt":{ "phone":"+79ХХХХХХХХХ", "email":"test@mail.ru" } }, "payer":"third", "paymentType":"cash", "promocode":"promo123", "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> <dataForReceipt> <phone>+79ХХХХХХХХХ</phone> <email>test@mail.ru</email> </dataForReceipt> </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> <dataForReceipt> <phone>+79ХХХХХХХХХ</phone> <email>test@mail.ru</email> </dataForReceipt> </receiver> <third> <counteragentID>9878696</counteragentID> <contact>3465688</contact> <contactList>12312343</contactList> <contactList>54364565</contactList> <phone>4656889</phone> <phoneNumbers>31234343</phoneNumbers> <phoneNumbers>36456565</phoneNumbers> <dataForReceipt> <phone>+79ХХХХХХХХХ</phone> <email>test@mail.ru</email> </dataForReceipt> </third> <payer>third</payer> <paymentType>cash</paymentType> <promocode>promo123</promocode> <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 | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
produceDate | Да | string | Дата подачи машины. Формат: ГГГГ-ММ-ДД |
produceTime | Да | string | Время подачи машины. Формат: ЧЧ:ММ |
derival | Да | DerivalArrival | Откуда |
arrival | Да | DerivalArrival | |
Member | |||
Нет* | Member | Данные третьего лица. *Если "payer" = "third", то параметр является обязательным | |
payer | Да | string | Плательщик. Доступные значения:
|
paymentType | Да | string | Тип оплаты. Доступные значения:
|
promocode | Нет | string | Промокод (обрабатывается оператором при оформлении заказа) |
mailback | Нет | string | Email для связи и уведомлений |
smsback | Нет | string | Телефон для связи и уведомлений по SMS Формат: 11 цифр с ведущей семеркой ("79999999999") |
comment | Нет | string | Комментарий к заказу |
cargoName | Да | string | Характер груза |
packed | Да | string | Тип имеющейся упаковки груза |
requester | Нет | string | Заказчик. UID одного из доступных контрагентов учетной записи ЛК. Может быть получен из метода "Получение списка контрагентов" |
role | Нет | string | Роль в перевозке. Доступные значения:
|
noFullAccess | Нет | boolean | Отсутствует полный доступ к контрагентам. Параметр необходимо передать, если у оформителя заявки в учетной записи ЛК нет контрагентов с полным доступом |
statedValue | Нет | float | Объявленная стоимость. Значение по умолчанию: "0" |
loading | Нет | boolean | Погрузка в месте подачи. Значение по умолчанию: "false" |
unloading | Нет | boolean | Разгрузка в месте назначения. Значение по умолчанию: "false" |
forwarder | Нет | boolean | Сопровождение груза. Доступные значения:
Значение по умолчанию: "true" |
carType | Да | integer | Арендуемая машина ID категории транспортного средства, полученный при помощи одного из методов - "Условия почасовой аренды (поиск по КЛАДР города)" или метода "Условия почасовой аренды (поиск по наименованию города)" |
manipulator | Нет | boolean | Манипулятор |
toCenter | Нет | boolean | Въезд в центр |
outerDistance | Нет | float | Расстояние за городом, км |
hazardClass | Нет | float | Класс опасности. Значение по умолчанию: "0". |
rentTime | Да | integer | Время аренды, час |
removeCover | Нет | boolean | Растентовка |
Derival
DerivalArrival | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
counteragentID | Да | integer | ID контрагента. Указывается на основании "Адресной книги" |
addressID | Да | integer | ID адреса. Указывается на основании "Адресной книги" |
Member
Member | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
counteragentID | Да | integer | ID контрагента. Указывается на основании "Адресной книги" |
contact | Да | integer | ID контактного лица или массив ID контактных лиц. Указывается на основании "Адресной книги". в запросе должен присутствовать только 1 из параметров |
contactList | Да | array of integers | |
phone | Да | integer | ID контактного телефона или Массив ID контактных телефонов. Указывается на основании "Адресной книги". В запросе должен присутствовать только 1 из параметров |
phoneNumbers | Да | array of integers | |
dataForReceipt | Нет | object | Контактные данные для отправки электронного чека плательщику-физическому лицу |
dataForReceipt.phone | Нет | string | Номер телефона для отправки чека. Формат номера: "+79XXXXXXXXX" (12 символов: начинается с "+79", и далее 9 цифр) |
dataForReceipt.email | Нет | string | Email адрес для отправки чека |
Ответ метода
Структура ответа
{ "order_id":7309608, "success":true }
<response> <order_id>7309608</order_id> <success>true</success> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
success | boolean | Признак успешности операции |
Обработка ошибок
Структура ответа
Формат ответа API в случае ошибки:
{ "state":"error", "errors":{ "smsback":"Значение параметра smsback не соответствует формату" } }
<response> <state>error</state> <errors> <smsback>Значение параметра smsback не соответствует формату</smsback> </errors> </response>
Виды ошибок
Ответ метода может содержать следующие специфичные ошибки:
Ошибка | Описание |
---|---|
Не указаны данные третьего лица | В параметре "payer" передано значение "third", но объект "third" отсутствует в запросе |
Значение параметра smsback не соответствует формату | Формат параметра: 11 цифр с ведущей семеркой (79999999999) |
| Значение параметра "dataForReceipt . phone" не соответствует формату: "+79XXXXXXXXX" (12 символов: начинается с "+79", и далее 9 цифр) |
Некорректное значение параметра "role" |
|
Недопустимое значение параметра "requester" |
|
Условия почасовой аренды (поиск по КЛАДР города)
Запрос метода
Структура запроса
Адрес метода: 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":"Тент/Фургон", "time_minimum":4, "time_to_delivery":1, "hourly_price":600, "outer_distance_price":17, "manipulator":false, "manipulator_price":0, "remove_cover":true, "remove_cover_price":500, "to_center":false, "to_center_price":0, "tonnage":2000, "volume":15, "length":4, "width":2, "height":1.95 }, { "city":"Санкт-Петербург", "id":143, "category":"Фургон", "time_minimum":5, "time_to_delivery":1, "hourly_price":650, "outer_distance_Price":23, "manipulator":false, "manipulator_price":0, "remove_cover":false, "remove_cover_price":0, "to_center":false, "to_center_price":0, "tonnage":3000, "volume":17, "length":4, "width":2.1000000000000001, "height":2.1000000000000001 } ] }
<response> <car_types> <city>Санкт-Петербург</city> <id>98</id> <category>Тент/Фургон</category> <time_minimum>4</time_minimum> <time_to_delivery>1</time_to_delivery> <hourly_price>600</hourly_price> <outer_distance_price>17</outer_distance_price> <manipulator>false</manipulator> <manipulator_price>0</manipulator_price> <remove_cover>true</remove_cover> <remove_cover_price>500</remove_cover_price> <to_center>false</to_center> <to_center_price>0</to_center_price> <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> <time_minimum>5</time_minimum> <time_to_delivery>1</time_to_delivery> <hourly_price>650</hourly_price> <outer_distance_price>23</outer_distance_price> <manipulator>false</manipulator> <manipulator_price>0</manipulator_price> <remove_cover>false</remove_cover> <remove_cover_price>0</remove_cover_price> <to_center>false</to_center> <to_center_price>0</to_center_price> <tonnage>3000</tonnage> <volume>17</volume> <length>4</length> <width>2.1</width> <height>2.1</height> </car_types> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
car_types | array of Car_types | Данные для категории транспортного средства |
Car_types
Car_types | ||
---|---|---|
Параметр | Тип | Описание |
city | string | Город |
id | integer | ID категории транспортного средства. Это значение нужно передавать в параметре "carType" метода "Оформление заявки на почасовую аренду" |
category | string | Наименование категории транспортного средства Возможные значения:
|
time_minimum | integer | Минимальное время заказа, ч |
time_to_delivery | integer | Время подачи машины, ч |
hourly_price | float | Стоимость аренды в черте населённого пункта, руб./ч |
outer_distance_price | float | Стоимость аренды за городом, руб./км |
manipulator | boolean | Флаг, обозначающий, что возможна аренда манипулятора |
manipulator_price | float | Стоимость аренды манипулятора, руб. Если услуга недоступна, то значение параметра равно "0" |
remove_cover | boolean | Флаг, обозначающий, что возможна растентовка |
remove_cover_price | float | Стоимость растентовки, руб. Если услуга недоступна, то значение параметра равно "0" |
to_center | boolean | Признак изменения стоимости аренды при заезде в центр города |
to_center_price | float | Стоимость аренды при заезде в центр города, руб./ч. Если стоимость не меняется, то значение параметра равно "0" |
tonnage | float | Грузоподъёмность транспортного средства, кг (1) |
volume | float | Объём транспортного средства, куб. м (1) |
length | float | Длина транспортного средства, м (1) |
width | float | Ширина транспортного средства, м (1) |
height | float | Высота транспортного средства, м (1) |
Примечания:
|
Обработка ошибок
Структура ответа
{ "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, "length":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, "length":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, "length":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> <length>4</length> <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> <length>6.5</length> <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> <length>4</length> <width>2.1</width> <height>2.1</height> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | array of Data | Информация для заказа почасовой аренды |
data.city | string | Город |
data.categoryId | integer | ID категории транспортного средства. Это значение нужно передавать в параметре "carType" метода "Оформление заявки на почасовую аренду" |
data.category | string | Наименование категории транспортного средства Возможные значения:
|
data.minOrderTime | float | Минимальное время заказа, ч |
data.vehDeliveryTime | float | Время подачи машины, ч |
data.aroundCity | float | Стоимость аренды в черте населённого пункта, руб./ч |
data.kilometerCostOut | float | Стоимость аренды за городом, руб./км |
data.manipulator | boolean | Флаг, обозначающий, что возможна аренда манипулятора |
data.manipulatorCost | float | Стоимость аренды манипулятора, руб. Если услуга недоступна, то значение параметра равно "0" |
data.tentRemoval | boolean | Флаг, обозначающий, что возможна растентовка |
data.tentRemovalCost | float | Стоимость растентовки, руб. Если услуга недоступна, то значение параметра равно "0" |
data.dropCenter | boolean | Признак изменения стоимости аренды при заезде в центр города |
data.dropCenterCost | float | Стоимость аренды при заезде в центр города, руб./ч. Если стоимость не меняется, то значение параметра равно "0" |
data.liftCapacity | float | Грузоподъёмность транспортного средства, кг (1) |
data.volume | float | Объём транспортного средства, куб. м (1) |
data.length | float | Длина транспортного средства, м (1) |
data.width | float | Ширина транспортного средства, м (1) |
data.height | float | Высота транспортного средства, м (1) |
Примечания:
|
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".