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

API
Главная / API - Список улиц по части названия

Список улиц по части названия

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

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

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

Поиск улиц

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

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

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

{  
   "appkey":"00000000-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-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <cityid>12345</cityid>
   <code>1000000100000010000000000</code>
   <street>Авто</street>
   <limit>2</limit>
</request>

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

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

sessionID

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

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

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

codeДа*string

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

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

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
ПараметрТипОписание
streetsarray of Response.StreetsСписок улиц

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

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

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

cityIDinteger

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

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

searchStringstring

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

aStringstring

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