Поиск терминалов
Общие сведения
Сервис позволяет получить список терминалов, доступных для сдачи и получения груза в указанном городе. Получить данные всех терминалов можно при помощи сервиса "Справочник терминалов"
Поиск терминалов
Запрос метода
Структура запроса
Адрес метода: 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 | Нет | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
code | Нет* | string | Код КЛАДР города. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР". *Запрос должен содержать один из взаимоисключающих параметров: "code" или "cityID" |
cityID | Нет* | integer | ID города, см. "Поиск населённых пунктов". *Запрос должен содержать один из взаимоисключающих параметров: "code" или "cityID" |
direction | Нет | string | Доступные значения:
|
Ответ метода
Структура ответа
{ "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 | ||
---|---|---|
Параметр | Тип | Описание |
terminals | array of Terminals | Список терминалов города, указанного пользователем в запросе, а также терминалов близлежащих населенных пунктов (при наличии). Если в городе, который указал пользователь, отсутствуют терминалы, то в списке выводятся терминалы ближайшего к нему населенного пункта. Список выводится без сортировки, терминалы отображаются в порядке следования данных в БД |
terminals.id | integer | ID терминала из "Справочника терминалов" |
terminals.city | string | Название города терминала |
terminals.cityID | integer | ID города терминала, см. "Справочника населенных пунктов" |
terminals.city_code | string | Код КЛАДР города терминала |
terminals.name | string | Наименование терминала |
terminals.address | string | Адрес терминала |
terminals.default | boolean | Признак терминала по умолчанию для города. Для каждого населенного пункта, по которому в ответе выводится информация, обязательно ровно один терминал является терминалом по умолчанию |
terminals.express | boolean | Признак работы терминала в режиме экспресс-терминала |