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

API
Главная / API - Терминалы по направлению

Терминалы по направлению

Обновлено 16.07.2020
77 кб

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

Сервис позволяет получить список терминалов, доступных для сдачи и получения груза в указанном городе. 

Терминалы по направлению

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

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

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

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "code":"7800000000000000000000000",
   "cityid":"2423",
   "direction":"derival"
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <code>7800000000000000000000000</code>
   <cityid>2423</cityid>
   <direction>derival</direction>
</request>

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

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

Код КЛАДР города. Может быть получен с помощью сервисов, представленных на странице "Использование кодов КЛАДР".

*Запрос должен содержать один из взаимоисключающих параметров: "code" или "cityID"

cityIDНет*integer

ID города из "Справочника населенных пунктов".

*Запрос должен содержать один из взаимоисключающих параметров: "code" или "cityID"

directionНетstring

Направление работы терминалов.

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

  • "derival" - для отправления;
  • "arrival" - для получения

Ответ метода

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

{  
   "terminals":[  
      {  
         "id":1,
         "city":"Санкт-Петербург",
         "cityID":1,
         "city_code":"7800000000000000000000000",
         "name":"Санкт-Петербург-Парнас",
         "address":"Санкт-Петербург, 1-й Верхний пер, дом № 12, литера Б",
         "default":true,
         "express":true
      }
   ]
}
<response>
   <terminals>
      <id>1</id>
      <city>Санкт-Петербург</city>
      <cityID>1</cityID>
      <city_code>7800000000000000000000000</city_code>
      <name>Санкт-Петербург-Парнас</name>
      <address>Санкт-Петербург, 1-й Верхний пер, дом № 12, литера Б</address>
      <default>true</default>
      <express>true</express>
   </terminals>
</response>

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

Response
Response
ПараметрТипОписание
terminalsarray of Terminals

Список терминалов города, указанного пользователем в запросе, а также терминалов близлежащих населенных пунктов (при наличии).

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

Список выводится без сортировки, терминалы отображаются в порядке следования данных в БД

terminals.idintegerID терминала из "Справочника терминалов"
terminals.citystringНазвание города терминала
terminals.cityIDintegerID города терминала из "Справочника населенных пунктов"
terminals.city_codestringКод КЛАДР города терминала
terminals.namestringНаименование терминала
terminals.addressstringАдрес терминала
terminals.defaultbooleanПризнак терминала по умолчанию для города. Для каждого населенного пункта, по которому в ответе выводится информация, обязательно ровно один терминал является терминалом по умолчанию
terminals.expressbooleanПризнак работы терминала в режиме экспресс-терминала