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

API
Главная / API - Поиск городов

Поиск городов

Обновлено 21.05.2018
80 кб

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

Метод возвращает список городов по части названия или информацию о городе по коду КЛАДР или по ID города.

Поиск городов

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

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

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

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

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

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

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

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

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

*Только если не переданы параметры "code" и "q". В противном случае параметр должен отсутствовать

codeДа*string

Код КЛАДР города

*Только если не переданы параметры "cityID" и "q". В противном случае параметр должен отсутствовать

qДа*string

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

*Только если не переданы параметры "code" и "cityID". В противном случае параметр должен отсутствовать

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
      },
      {  
         "code":"2302300000100000000000000",
         "aString":"Мостовской пгт (Краснодарский край)",
         "isTerminal":0,
         "zoneID":385,
         "region_name":"Краснодарский край",
         "searchString":"Мостовской",
         "regionID":16,
         "cityID":29032,
         "cityUID":"0x81e100112fdd658311da55b5652db4be",
         "postalCode":352570,
         "inPrice":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>
   </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>
   </cities>
</response>

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

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

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

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

aStringstring

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

isTerminalinteger

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

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

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

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

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

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

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

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

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

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