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

API
Главная / API - Заявка на почасовую аренду

Заявка на почасовую аренду

Обновлено 08.09.2017
86 кб

Общая информация

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

Заявка на почасовую аренду

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

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

{
   "appkey": "00000000-0000-0000-000000000000",
   "session_id": "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
        ]
   },
   "receiver": {
      "counteragent_id": 5775755,
      "contact": 3465688,
      "contactList": [
         12312343,
         54364565
        ],
      "phone": 4656889,
      "phoneNumbers": [
         31234343,
         36456565
        ]
    },
   "derival": {
      "counteragentID": 5775755,
      "addressID": 4545885
    },
   "arrival": {
      "counteragentID": 5353453,
      "addressID": 6523423
    },
   "third": {
      "counteragentID": 9878696,
      "contact": 3465688,
      "contactList": [
         12312343,
         54364565
        ],
      "phone": 4656889,
      "phoneNumbers": [
         31234343,
         36456565
        ]
    },
   "statedValue": 100.90,
   "loading": true,
   "unloading": false,
   "forwarder": false,
   "payer": "third",
   "paymentType": "cash",
   "mailback": "test@mail.ru",
   "smsback": "79214587878",
   "comment": "test test"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <session_id>00000000-0000-0000-0000-000000000000</session_id>
   <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>
   </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>
   </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>
   </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>
</request>

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

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

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

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

Дополнительные услуги

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"

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

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

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

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

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

phoneNumbersДаarray of integer
contactДаinteger

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

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

contactListДаarray of integer
Параметры объектов "Request.Receiver" и "Request.Third" аналогичны параметрам объекта ""

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

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

Ответ метода

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

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

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

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

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

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

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

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

Виды ошибок

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

ОшибкаОписание
Не указаны данные третьего лицаВ параметре "payer" передано значение "third", но объект "third" отсутствует в запросе
Значение параметра smsback не соответствует форматуФормат параметра: 11 цифр с ведущей семеркой (79999999999)