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

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

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

Обновлено 26.02.2021
128 кб

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

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

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

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

Адрес метода: 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",
   "carType":216,
   "manipulator":true,
   "toCenter":true,
   "outerDistance":20.5,
   "hazardClass":1,
   "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"
      }
   },
   "derival":{
      "counteragentID":5775755,
      "addressID":4545885
   },
   "arrival":{
      "counteragentID":5353453,
      "addressID":6523423
   },
   "third":{
      "counteragentID":9878696,
      "contact":3465688,
      "contactList":[
         12312343,
         54364565
      ],
      "phone":4656889,
      "phoneNumbers":[
         31234343,
         36456565
      ],
      "data_for_receipt":{
         "phone":"+79ХХХХХХХХХ",
         "email":"test@mail.ru"
      }
   },
   "statedValue":100.90,
   "loading":true,
   "unloading":false,
   "forwarder":false,
   "payer":"third",
   "paymentType":"cash",
   "mailback":"test@mail.ru",
   "smsback":"79214587878",
   "comment":"test test",
   "cargoName":"Запчасти для трактора",
   "packed":"0x9a7f11408f4957d7494570820fcf4549",
   "requester":"5775755",
   "role":"third",
   "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>
   <carType>216</carType>
   <manipulator>true</manipulator>
   <toCenter>true</toCenter>
   <outerDistance>20.5</outerDistance>
   <hazardClass>1</hazardClass>
   <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>
   <derival>
      <counteragentID>5775755</counteragentID>
      <addressID>4545885</addressID>
   </derival>
   <arrival>
      <counteragentID>5353453</counteragentID>
      <addressID>6523423</addressID>
   </arrival>
   <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>
   <statedValue>100.9</statedValue>
   <loading>true</loading>
   <unloading>false</unloading>
   <forwarder>false</forwarder>
   <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>
   <rentTime>5</rentTime>
   <removeCover>false</removeCover>
</request>

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

Request
ПараметрОбязательныйТипОписание
Основные параметры
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
derivalДаRequest.DerivalОткуда 
arrivalДаRequest.ArrivalКуда 
senderДаRequest.SenderДанные отправителя
receiverДаRequest.ReceiverДанные получателя
thirdДа*Request.Third

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

*Только если "payer" = "third"

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"

Данные по плательщику

payerДаstring

Плательщик.

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

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

Тип оплаты.

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

  • "cash" - оплата наличными
  • "non_cash" - безналичная оплата

Контактные данные

mailbackНетstringE-mail для связи и уведомлений
smsbackНетstring

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

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

commentНетstringКомментарий к заказу

Параметры машины и услуги 

carTypeДаinteger

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

ID категории транспортного средства, полученный из справочника "Информация для заказа почасовой аренды" (либо из метода получения информации)

produceDateДаstring

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

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

produceTimeДаstring

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

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

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

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

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

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

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

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

Request.Sender
ПараметрR*ТипОписание
counteragentIDДаintegerID контрагента. Указывается на основании "Адресной книги"
phoneДаinteger

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

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

phoneNumbersДаarray of integers
contactДаinteger

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

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

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

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

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

data_for_receipt.emailНетstringE-mail адрес для отправки чека
Параметры объектов "Request.Receiver" и "Request.Third"аналогичны параметрам объекта "Request.Sender"

Заполнение параметров раздела "Параметры машины и услуги"

Для корректного заполнения параметров необходимо воспользоваться информацией, полученной либо из метода "Условия почасовой аренды", либо из справочника "Информация для заказа почасовой аренды".

Ответ метода

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

{
   "order_id":7309608,
   "success":true
}
<response>
   <order_id>7309608</order_id>
   <success>true</success>
</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 несуществующего контрагента
  • В аккаунте отсутствуют контрагенты