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

Ключ

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

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

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

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

 

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

Блок кода
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": "Пензенская обл, Камешкирский р-н, село Красное Поле"
        }
    ]
}

 

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

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

...

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

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

Image Added

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

  • Регион

    Без форматирования
    {
      "from_bound": {
        "value": "region"
      },
      "to_bound": {
        "value": "region"
      },
      "query": "самарская"
    }
  • Район

    Без форматирования
    # значение region_fias_id взято от вышестоящего поля («Регион») после того, как пользователь выбрал в нем подсказку из списка
    {
      "locations": [
        {
          "region_fias_id": "df3d7359-afa9-4aaa-8ff9-197e73906b1c"
        }
      ],
      "from_bound": {
        "value": "area"
      },
      "to_bound": {
        "value": "area"
      },
      "restrict_value": true,
      "query": "алексеевский"
    }
  • Город

    Без форматирования
    # значение region_fias_id взято от вышестоящего поля («Регион») после того, как пользователь выбрал в нем подсказку из списка
    # если бы пользователь заполнил район, вместо region_fias_id было area_fias_id
    {
      "locations": [
        {
          "region_fias_id": "df3d7359-afa9-4aaa-8ff9-197e73906b1c"
        }
      ],
      "from_bound": {
        "value": "city"
      },
      "to_bound": {
        "value": "city"
      },
      "restrict_value": true,
      "query": "самара"
    }
  • Населенный пункт

    Без форматирования
    # значение city_fias_id взято от вышестоящего поля («Город») после того, как пользователь выбрал в нем подсказку из списка
    # если бы пользователь не заполнил город, вместо city_fias_id было area_fias_id или region_fias_id
    {
      "locations": [
        {
          "city_fias_id": "bb035cc3-1dc2-4627-9d25-a1bf2d4b936b"
        }
      ],
      "from_bound": {
        "value": "settlement"
      },
      "to_bound": {
        "value": "settlement"
      },
      "restrict_value": true,
      "query": "мехзавод"
    }
  • Улица

    Без форматирования
    # значение settlement_fias_id взято от вышестоящего поля («Населенный пункт») после того, как пользователь выбрал в нем подсказку из списка
    # если бы пользователь не заполнил населенный пункт, вместо settlement_fias_id было city_fias_id
    {
      "locations": [
        {
          "settlement_fias_id": "5e30bb6c-87e7-4550-8f4c-546981a24647"
        }
      ],
      "from_bound": {
        "value": "street"
      },
      "to_bound": {
        "value": "street"
      },
      "restrict_value": true,
      "query": "анжерская"
    }
  • Дом

    Без форматирования
    # значение street_fias_id взято от вышестоящего поля («Улица») после того, как пользователь выбрал в нем подсказку из списка
    # если бы пользователь не заполнил улицу, вместо street_fias_id было settlement_fias_id
    {
      "locations": [
        {
          "street_fias_id": "dd08e4e2-82ff-43b5-81f7-93f59f013974"
        }
      ],
      "from_bound": {
        "value": "house"
      },
      "restrict_value": true,
      "query": "12"
    }