value и unrestricted_value — это текст подсказки одной строкой. Их показывают в списке подсказок человеку. Поля не предназначены для автоматических интеграций, потому что их формат может со временем измениться.

Вот как заполняются поля value и unrestricted_value для разных справочников:

Адрес

value

Поле value содержит адрес одной строкой. Склеивается из полей объекта data:
  • postal_code (индекс),
  • country (страна),
  • region_with_type (регион с типом),
  • area_with_type (район в регионе с типом),
  • sub_area_with_type (мун. поселение с типом),
  • city_with_type (город с типом),
  • city_district_with_type (адм. район города с типом),
  • settlement_with_type (населенный пункт с типом),
  • street_with_type (улица с типом),
  • stead_type (тип участка),
  • stead (участок),
  • house_type (тип дома),
  • house (дом),
  • block_type (тип корпуса/строения),
  • block (корпус/строение),
  • flat_type (тип квартиры),
  • flat (квартира),
  • room_type (тип комнаты),
  • room (комната).

При этом действуют правила, описанные ниже.

Индекс

Обычно индекс (поле postal_code) не пишется. Но если в списке подсказок получаются полные дубли (обычно такое бывает, если в городе несколько улиц с одинаковым названием), и дописывание района города не помогло разрешить неоднозначность (обычно такое бывает, если район для улиц неизвестен) — то индекс пишется.

Страна

Обычно страна (поле country) не пишется. Но для международных подсказок (если в параметрах запроса явно задано ограничение на страну помимо России) — пишется.

Города-регионы и города-районы

Для городов-регионов (например, Москва) пишется регион (region_with_type), но не одноименный город (city_with_type).

Для городов-районов (например, Одинцово в Московской области) пишется район (area_with_type), но не одноименный город (city_with_type).

Областные и районные центры

Если город — областной центр, регион (region_with_type) не пишется (Новосибирская обл, г Новосибирск → г Новосибирск);

Если город — центр района, район (area_with_type) не пишется (Респ Татарстан, Верхнеуслонский р-н, село Верхний Услон → Респ Татарстан, село Верхний Услон).

Сокращенная запись муниципального деления

Для адресов в муниципальном делении действуют правила, которые записывают адрес в удобочитаемом виде (мун. деление в оригинале очень громоздкое). Примеры:

region_with_type: Московская обл
area_with_type: г.о. Одинцовский
city_with_type: г Одинцово
→ value = Московская обл, г Одинцово

region_with_type: г Москва
area_with_type: вн.тер.г. городской округ Щербинка
city_with_type: г Щербинка
street_with_type: Остафьевское шоссе
→ value = г Москва, г Щербинка, Остафьевское шоссе

region_with_type: г Москва
area_with_type: вн.тер.г. муниципальный округ Северное Медведково
street_with_type: ул Сухонская
house_type: д
house: 11
→ value = г Москва, ул Сухонская, д 11

region_with_type: Самарская обл
area_with_type: г.о. Самара
sub_area_with_type: вн.р-н Железнодорожный
city_with_type: г Самара
street_with_type: ул Сакко и Ванцетти
house_type: д
house: 20
→ value = Самарская обл, г Самара, ул Сакко и Ванцетти, д 20

Район города

Обычно район города (в адм. делении это поле city_district_with_type, в мун. делении может быть в area_with_type или в sub_area_with_type) не пишется. Но если в списке подсказок получаются полные дубли (обычно такое бывает, если в городе несколько улиц с одинаковым названием, например улица 8 Марта в Москве) — то район пишется.

Параметр restrict_value

Если в запросе указан параметр restrict_value, то в поле value возвращается только часть адреса, которая подходит под ограничение. Например:

region = Москва, restrict_value = false, query = сакко
→ value = г Самара, ул Сакко и Ванцетти

region = Москва, restrict_value = true, query = сакко
→ value = ул Сакко и Ванцетти

unrestricted_value

Поле unrestricted_value содержит адрес одной строкой. Оно склеивается из полей объекта data:
  • postal_code (индекс),
  • country (страна),
  • region_with_type (регион с типом),
  • area_with_type (район в регионе с типом),
  • sub_area_with_type (мун. поселение с типом),
  • city_with_type (город с типом),
  • city_district_with_type (адм. район города с типом),
  • settlement_with_type (населенный пункт с типом),
  • street_with_type (улица с типом),
  • stead_type (тип участка),
  • stead (участок),
  • house_type (тип дома),
  • house (дом),
  • block_type (тип корпуса/строения),
  • block (корпус/строение),
  • flat_type (тип квартиры),
  • flat (квартира),
  • room_type (тип комнаты),
  • room (комната).

При этом действуют правила, описанные ниже.

Страна

Обычно страна (поле country) не пишется. Но для международных подсказок (если в параметрах запроса явно задано ограничение на страну помимо России) — пишется.

Города-регионы и города-районы

Для городов-регионов (например, Москва) пишется регион (region_with_type), но не одноименный город (city_with_type).

Для городов-районов (например, Одинцово в Московской области) пишется район (area_with_type), но не одноименный город (city_with_type).

Организация

Поле value содержит краткое наименование организации (data.name.short_with_opf). Если краткое наименование не указано, поле value содержит полное наименование (data.name.full_with_opf).

Поле unrestricted_value всегда равно value.

Банк

Поле value содержит краткое наименование банка (data.name.short). Если краткое наименование не указано, поле value содержит платежное наименование (data.name.payment).

Поле unrestricted_value всегда равно value.

ФИО

Поле value содержит ФИО одной строкой (data.surname + data.name + data.patronymic).

Если запрос соответствует только части ФИО, в поле value возвращается эта часть:

query = викт
→ value = Виктор

query = ольга за
→ value = Ольга Захарова

query = захарова елена к

→ value = Захарова Елена Константиновна

Поле unrestricted_value всегда равно value.

Email

Поле value содержит адрес эл. почты  одной строкой (data.local + @ + data.domain).

Если в запросе нет «собачки», в поле value возвращается только локальная часть:

query = vikt
→ value = viktor

query = olga@
→ value = olga@mail.ru

query = elena@bank.
→ value = elena@bank.ru

Поле unrestricted_value всегда равно value.

Внешние справочники

Поля value и unrestricted_value заполняются в соответствии с конфигурацией справочника.

  • No labels