value
и unrestricted_value
— это текст подсказки одной строкой. Их показывают в списке подсказок человеку. Поля не предназначены для автоматических интеграций, потому что их формат может со временем измениться.
Вот как заполняются поля value и unrestricted_value для разных справочников:
Адрес
value
Поле value
содержит адрес одной строкой от региона до квартиры. Склеивается из полей:
- data.region_with_type (регион с типом),
- data.area_with_type (район в регионе с типом),
- data.city_with_type (город с типом),
- data.settlement_with_type (населенный пункт с типом),
- data.street_with_type (улица с типом),
- data.house_type (тип дома),
- data.house (дом),
- data.block_type (тип корпуса/строения),
- data.block (корпус/строение),
- data.flat_type (тип квартиры),
- data.flat (квартира).
При этом применяются правила сокращения адреса для деловой переписки:
- если город — областной центр, область не пишется (Новосибирская обл, г Новосибирск → г Новосибирск);
- если город — центр района, не пишется район (Респ Татарстан, Верхнеуслонский р-н, село Верхний Услон → Респ Татарстан, село Верхний Услон).
Если в запросе к API указан параметр restrict_value, то в поле value возвращается только часть адреса, которая подходит под ограничение. Например:
region = Москва, restrict_value = false, query = сакко → value = г Самара, ул Сакко и Ванцетти region = Москва, restrict_value = true, query = сакко → value = ул Сакко и Ванцетти
unrestricted_value
Поле unrestricted_value
содержит адрес одной строкой от индекса до квартиры. Оно склеивается из полей:
- data.postal_code (индекс),
- data.region_with_type (регион с типом),
- data.area_with_type (район в регионе с типом),
- data.city_with_type (город с типом),
- data.city_district_with_type (район города с типом),
- data.settlement_with_type (населенный пункт с типом),
- data.street_with_type (улица с типом),
- data.house_type (тип дома),
- data.house (дом),
- data.block_type (тип корпуса/строения),
- data.block (корпус/строение),
- data.flat_type (тип квартиры),
- data.flat (квартира).
Сокращение по правилам деловой переписки к unrestricted_value не применяются и параметр restrict_value
на него не влияет.
Организация
Поле 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
.
Поле 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
заполняются в соответствии с конфигурацией справочника.