Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Если задать параметры параметры from_bound и  и  to_bound, то будут подсказки только для указанных частей указанных частей адреса.

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

НазваниеОписание
countryСтрана
regionРегион
areaРайонcityГородsettlementНаселенный пунктstreetУлицаhouseДом

Оглавление

Подсказки по отдельным компонентам адреса

areaРайон
cityГород
settlementНаселенный пункт
streetУлица
houseДом

Оглавление

Подсказки по отдельным компонентам адреса

Только страны

Работает только при поиске по зарубежным адресам с версии подсказок 19.8

Блок кода
titleзапрос
{
    "query": "ро",
	"from_bound": { "value": "country" }, 
	"to_bound": { "value": "country" },
    "locations": [
        {
            "country_iso_code": "*"
        }
    ]   
}
Блок кода
languagexml
titleзапрос в XML
collapsetrue
<req>
  <query>ро</query>
  <from_bound>
    <value>country</value>
  </from_bound>
  <to_bound>
    <value>country</value>
  </to_bound>
  <locations>
  	<country_iso_code>*</country_iso_code>
  </locations>
</req>
Блок кода
titleответ
collapsetrue
{
    "suggestions": [
        {
            "value": "Россия"
        },
        {
            "value": "Остров Рождества"
        }
    ]
}

Только регионы

Блок кода
titleзапрос
{
    "query": "Пе",
	"from_bound": { "value": "region" }, 
	"to_bound": { "value": "region" }   
}

...

Блок кода
titleответ
collapsetrue
{
    "suggestions": [
        {
            "value": "г Санкт-Петербург"
        },
        {
            "value": "Пермский край"
        },
        {
            "value": "Пензенская обл"
        }
    ]
}

Города

Блок кода
titleзапрос
{
    "query": "Пет",
	"from_bound": { "value": "city" }, 
	"to_bound": { "value": "city" }   
}

...

Блок кода
titleответ
collapsetrue
{
    "suggestions": [
        {
            "value": "г Санкт-Петербург"
        },
        {
            "value": "респ Карелия, г Петрозаводск"
        },
        {
            "value": "Камчатский край, г Петропавловск-Камчатский"
        },
        {
            "value": "г Санкт-Петербург, г Петергоф"
        },
        {
            "value": "Саратовская обл, г Петровск"
        }
    ]
}

Улицы в Москве

Блок кода
titleзапрос
{
    "query": "тур",
    "from_bound": { "value": "street" },
    "to_bound": { "value": "street" },
    "locations": [{ "region": "москва" }],
	"restrict_value": true
}

...

Блок кода
titleответ
collapsetrue
{
    "suggestions": [
        {
            "value": "г Москва, Тургеневская пл"
        },
        {
            "value": "г Москва, ул Туристская"
        },
        {
            "value": "г Москва, Туркменский проезд"
        },
        {
            "value": "г Москва, Турчанинов пер"
        }
    ]
}

...

Города и села в Пензенской области

Блок кода
titleзапрос
{
    "query": "Красное",
	"from_bound": { "value": "city" }, 
	"to_bound": { "value": "settlement" },
	"locations": [{ "region": "Пензенская" }],
	"restrict_value": true
}

...

Блок кода
titleответ
collapsetrue
{
    "suggestions": [
        {
            "value": "Пензенская обл, Мокшанский р-н, поселок Красное Польцо"
        },
        {
            "value": "Пензенская обл, Земетчинский р-н, поселок Красное Знамя"
        },
        {
            "value": "Пензенская обл, Никольский р-н, село Красное"
        },
        {
            "value": "Пензенская обл, Камешкирский р-н, село Красное Поле"
        }
    ]
}

Полностью гранулярный ввод адреса

Пусть есть форма:

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

Регион

Блок кода
languagejs
titleв JSON
{
  "from_bound": {
    "value": "region"
  },
  "to_bound": {
    "value": "region"
  },
  "query": "самарская"
}
Блок кода
languagexml
titleв XML
collapsetrue
<req>
  <from_bound>
    <value>region</value>
  </from_bound>
  <to_bound>
    <value>region</value>
  </to_bound>
  <query>самарская</query>
</req>

Район в выбранном регионе

Значение region_fias_id взято от вышестоящего поля («Регион») после того, как пользователь выбрал в нем подсказку из списка:

...

Блок кода
languagexml
titleв XML
collapsetrue
<req>
  <locations>
    <region_fias_id>df3d7359-afa9-4aaa-8ff9-197e73906b1c</region_fias_id>
  </locations>
  <from_bound>
    <value>area</value>
  </from_bound>
  <to_bound>
    <value>area</value>
  </to_bound>
  <restrict_value>true</restrict_value>
  <query>алексеевский</query>
</req>

Город в выбранном регионе

Значение region_fias_id взято от вышестоящего поля («Регион») после того, как пользователь выбрал в нем подсказку из списка. Если бы пользователь заполнил район, вместо region_fias_id было area_fias_id.

...

Блок кода
languagexml
titleв XML
collapsetrue
<req>
  <locations>
    <region_fias_id>df3d7359-afa9-4aaa-8ff9-197e73906b1c</region_fias_id>
  </locations>
  <from_bound>
    <value>city</value>
  </from_bound>
  <to_bound>
    <value>city</value>
  </to_bound>
  <restrict_value>true</restrict_value>
  <query>самара</query>
</req>

Населённый пункт в выбранном городе

Значение city_fias_id взято от вышестоящего поля («Город») после того, как пользователь выбрал в нем подсказку из списка. Если бы пользователь не заполнил город, вместо city_fias_id было area_fias_id или region_fias_id.

...

Блок кода
languagexml
titleв XML
collapsetrue
<req>
  <locations>
    <city_fias_id>bb035cc3-1dc2-4627-9d25-a1bf2d4b936b</city_fias_id>
  </locations>
  <from_bound>
    <value>settlement</value>
  </from_bound>
  <to_bound>
    <value>settlement</value>
  </to_bound>
  <restrict_value>true</restrict_value>
  <query>мехзавод</query>
</req>

Улица в выбранном населённом пункте

Значение settlement_fias_id взято от вышестоящего поля («Населенный пункт») после того, как пользователь выбрал в нем подсказку из списка. Если бы пользователь не заполнил населенный пункт, вместо settlement_fias_id было city_fias_id.

...

Блок кода
languagexml
titleв XML
collapsetrue
<req>
  <locations>
    <settlement_fias_id>5e30bb6c-87e7-4550-8f4c-546981a24647</settlement_fias_id>
  </locations>
  <from_bound>
    <value>street</value>
  </from_bound>
  <to_bound>
    <value>street</value>
  </to_bound>
  <restrict_value>true</restrict_value>
  <query>анжерская</query>
</req>

Дом на выбранной улице

Значение street_fias_id взято от вышестоящего поля («Улица») после того, как пользователь выбрал в нем подсказку из списка. Если бы пользователь не заполнил улицу, вместо street_fias_id было settlement_fias_id.

...

Блок кода
languagexml
titleв XML
collapsetrue
<req>
  <locations>
    <street_fias_id>dd08e4e2-82ff-43b5-81f7-93f59f013974</street_fias_id>
  </locations>
  <from_bound>
    <value>house</value>
  </from_bound>
  <to_bound>
    <value>house</value>
  </to_bound>
  <restrict_value>true</restrict_value>
  <query>12</query>
</req>

...