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

API
Главная / API - Поиск географических объектов

Поиск географических объектов

Обновлено 15.06.2021
158 кб

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

Сервис позволяет найти страну, населённый пункт или улицу по части их названия, а также получить информацию о населённом пункте (пo КЛАДР/ID) или улице (по КЛАДР). Чтобы получить информацию обо всех улицах/населённых пунктах, следует воспользоваться сервисом "Справочники географических объектов". Для поиска КЛАДР населённого пункта можно использовать сервис "Поиск КЛАДР"

Поиск стран

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

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "filter":"Бел"
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <filter>Бел</filter>
</request>

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

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

Часть названия страны. Используется для подбора результата по началу строки.

Подбор осуществляется только в том случае, если в запросе передан один параметр.

Если в запросе передано несколько параметров, то ответе приводится полный список стран

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "countryUID":"0x8f51001438c4d49511dbd774581edb7e",
         "country":"Беларусь"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <countryUID>0x8f51001438c4d49511dbd774581edb7e</countryUID>
      <country>Беларусь</country>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200"
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataИнформация о стране
data.countryUIDstringUID страны
data.countrystringНаименование страны

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Поиск населённых пунктов

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

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

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

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "cityID":"200555",
   "code":"1000000100000010000000000",
   "q":"мос",
   "limit":10
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <cityid>200555</cityid>
   <code>1000000100000010000000000</code>
   <q>Авто</q>
   <limit>10</limit>
</request>

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

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

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

*Запрос должен содержать один из параметров: "cityID", "code", "q"

codeНет*string

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

*Запрос должен содержать один из параметров: : "cityID", "code", "q"

qНет*string

Часть названия города

*Запрос должен содержать один из параметров: "cityID", "code", "q"

limitНет*integer

Максимальное количество выводимых элементов списка. Минимальное значение - "1".

*Параметр является обязательным, если передан параметр "q"

Ответ метода

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

{  
   "cities":[  
      {  
         "code":"7700000000000000000000000",
         "aString":"г. Москва",
         "isTerminal":1,
         "zoneID":0,
         "region_name":"г. Москва",
         "searchString":"Москва",
         "regionID":75,
         "cityID":200555,
         "cityUID":"0x834f00112fdd658311da4c6326ef0e13",
         "postalCode":101000,
         "inPrice":1,
         "street":1
      },
      {  
         "code":"2302300000100000000000000",
         "aString":"Мостовской пгт (Краснодарский край)",
         "isTerminal":0,
         "zoneID":385,
         "region_name":"Краснодарский край",
         "searchString":"Мостовской",
         "regionID":16,
         "cityID":29032,
         "cityUID":"0x81e100112fdd658311da55b5652db4be",
         "postalCode":352570,
         "inPrice":1,
         "street":1
      }
   ]
}
<response>
   <cities>
      <code>7700000000000000000000000</code>
      <astring>г. Москва</astring>
      <isterminal>1</isterminal>
      <zoneid>0</zoneid>
      <region_name>г. Москва</region_name>
      <searchstring>Москва</searchstring>
      <regionid>75</regionid>
      <cityid>200555</cityid>
      <cityuid>0x834f00112fdd658311da4c6326ef0e13</cityuid>
      <postalcode>101000</postalcode>
      <inprice>1</inprice>
      <street>1</street>
   </cities>
   <cities>
      <code>2302300000100000000000000</code>
      <astring>Мостовской пгт (Краснодарский край)</astring>
      <isterminal>0</isterminal>
      <zoneid>385</zoneid>
      <region_name>Краснодарский край</region_name>
      <searchstring>Мостовской</searchstring>
      <regionid>16</regionid>
      <cityid>29032</cityid>
      <cityuid>0x81e100112fdd658311da55b5652db4be</cityuid>
      <postalcode>352570</postalcode>
      <inprice>1</inprice>
      <street>1</street>
   </cities>
</response>

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

Response
Response
ПараметрТипОписание
citiesarray of CitiesСписок городов

Cities
ПараметрТипОписание
codestring

Код КЛАДР населенного пункта

aStringstring

Полное название населенного пункта с указанием его типа ("г.", "пгт" и т. п.)

isTerminalinteger

Признак наличия терминалов в населенном пункте.

Возможные значения:

  • "1" - в населенном пункте есть терминалы;
  • "0" - в населенном пункте нет терминалов
zoneIDintegerID административного округа. При отсутствии данных принимает значение "0"
region_namestringНазвание региона (субъекта РФ), к которому относится населенный пункт
searchStringstring

Название населенного пункта без указания его типа

regionIDintegerID региона (субъекта РФ), к которому относится населенный пункт
cityIDinteger

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

cityUIDstringUID населенного пункта
postalCodeintegerПочтовый индекс
inPriceinteger

Признак наличия населенного пункта в "Справочнике городов из прайс-листа".

Возможные значения:

  • "1" - населенном пункт есть в справочнике;
  • "0" - населенного пункта нет в справочнике
streetinteger

Признак наличия улиц в населенном пункте.

Возможные значения:

  • "1" - в населенном пункте возможно наличие улиц;
  • "0" - в населенном пункте нет улиц
Если в запросе метода передан параметр "code" или "cityID", то ответ будет содержать информацию только об одном городе.

Поиск улиц

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

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

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

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "cityID":12345,
   "code":"1000000100000010000000000",
   "street":"Авто",
   "limit":2
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <cityid>12345</cityid>
   <code>1000000100000010000000000</code>
   <street>Авто</street>
   <limit>2</limit>
</request>

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

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

sessionID

НетstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
cityIDНет*integer

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

*В запросе обязательно должен быть передан один из параметров: "cityID" и "code"

codeНет*string

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

*В запросе обязательно должен быть передан один из параметров: "cityID" и "code"

streetНет*string

Часть названия улицы

*Параметр обязателен, только если передан параметр "cityID"

limitДаintegerМаксимальное количество выводимых элементов списка

Ответ метода

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

{  
   "streets":[  
      {  
         "code":1000000100000010000000000,
         "cityID":12345,
         "searchString":"Автолюбителей",
         "aString":"Автолюбителей проезд"
      },
      {  
         "code":1000000100000020000000000,
         "cityID":12345,
         "searchString":"Автомобильная",
         "aString":"Автомобильная ул"
      }
   ]
}
<response>
   <streets>
      <code>1000000100000010000000000</code>
      <cityid>12345</cityid>
      <searchstring>Автолюбителей</searchstring>
      <astring>Автолюбителей проезд</astring>
   </streets>
   <streets>
      <code>1000000100000020000000000</code>
      <cityid>12345</cityid>
      <searchString>Автомобильная</searchString>
      <astring>Автомобильная ул</astring>
   </streets>
</response>

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

Response
Response
ПараметрТипОписание
streetsarray of StreetsСписок улиц

Streets
ПараметрТипОписание
codeinteger

Код КЛАДР улицы.

Выводится, только если запрос содержал параметр "cityID"

cityIDinteger

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

Выводится, только если запрос содержал параметр "code"

searchStringstring

Найденное название улицы

aStringstring

Найденное название улицы с указанием ее типа ("ул", "проезд" и т. п.)