Общая информация
Компонент предназначен для подтверждения адреса из ЕСИА. Доступен для физических лиц, организаций и индивидуальных предпринимателей.
Поддерживаемые экраны
Компонент может быть задействован на экранах типа:
Внешний вид компонента
В услуге
Пример экрана проверки адреса постоянной регистрации
Пример экрана при отсутствии адреса временной регистрации
В конструкторе
Структура компонента ConfirmAddress
ВКУ |
JSON |
|||
№ |
В конструкторе |
Атрибут |
Тип |
Описание |
1 |
Идентификатор компонента |
id |
string |
Уникальный идентификатор компонента в JSON |
2 |
Удобочитаемое имя компонента |
name |
string |
Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент |
Атрибуты компонента |
||||
3 |
Тип адреса |
addrType |
string |
Выпадающий список с возможностью выбора типа проверяемого адреса. Доступны: адрес проживания, адрес временной регистрации, адрес постоянной регистрации, юридический адрес ЮЛ, почтовый адрес ЮЛ, адрес места регистрации ребёнка, адрес проживания ребёнка |
4 |
Показывать дату |
regData |
string |
Для адресов, у которых есть дата, возможно выбрать её отображение |
Текст подсказки, если адрес не заполнен в ЛК |
||||
5 |
Заголовок |
title |
string |
Заголовок дисклеймера, который появляется в случае отсутствия адреса в ЛК. Если оставить поле пустым, будет подставлен заголовок по умолчанию, как в примере внешнего вида компонента |
6 |
Текст |
value |
string |
Текст дисклеймера, который появляется в случае отсутствия адреса в ЛК. Если оставить поле пустым, будет поставлен стандартный текст, как в примере внешнего вида компонента |
7 |
Цвет «значка» |
type |
array |
Цвет дисклеймера, который появляется в случае отсутствия адреса в ЛК. Если оставить пустым, будет выбран красный цвет |
8 |
Массив полей для задания валидации |
fields |
array |
Блок позволяет установить валидацию отдельных элементов адреса и дат регистрации по регулярным выражениям |
9 |
Тип отображаемого адреса |
|||
Список получаемых данных по адресным объектам |
||||
10 |
Задается список полей из адресных объектов дадаты и ЕСИА. Пример «esia.addressStr». Если поля не указать, то по умолчанию они не вернутся в ответе |
|||
Названия для отображаемых полей |
||||
11 |
Название поля с адресом |
addressLabel |
string |
Поле задаёт лейбл поля. В абсолютном большинстве случаев требуется название «Адрес» |
Доступные действия |
||||
12 |
Надпись на кнопке |
label |
string |
Текст, отображаемый на кнопке редактирования. Обычно это будет «Редактировать» |
13 |
Действие |
action |
string |
Выпадающий список с возможными действиями: редактирования адресов постоянной и временной регистрации, адреса проживания, а также адреса ребёнкаю |
14 |
type |
string |
Заполняется автоматически в соответствии с дейстивем |
|
15 |
Пояснительные переходы |
clarifications |
object, array |
Позволяет отобразить и использовать функционал создания модального окна или массив ссылок на ранее введённые данные |
16 |
Настройка пояснительных переходов в компоненте |
acceptableTypes |
additionalProperties |
Настройка модальных окон |
17 |
Подсказка, отображаемая вместо кнопки редактирования |
hint |
string |
Текст, выводящийся пользователю вместо кнопки, настраиваемой в «Доступных действиях». Нужен для создания поп-апа «Откуда эти данные и как исправить ошибку» в сценарии подтверждения юридического адреса |
18 |
Включить нормализацию адреса в компоненте |
|||
>
32 |
Идентификатор подсказки/саджеста/suggest |
suggestionId |
string |
Механизм отображения пользователю набора подходящих для ввода данных и автоматическое заполнение полей формы этими данными |
Пример JSON структуры компонента передаваемой в DTO
{
"address": {
"regionType": "область",
"regionShortType": "обл",
"region": "Смоленская",
"cityType": "город",
"cityShortType": "г",
"city": "Вязьма",
"districtType": "район",
"districtShortType": "р-н",
"district": "Вяземский",
"townType": "садовое товарищество",
"townShortType": "снт",
"town": "Восход",
"inCityDistType": "",
"inCityDistShortType": "",
"inCityDist": "",
"streetType": "",
"streetShortType": "",
"street": "",
"additionalAreaType": "",
"additionalAreaShortType": "",
"additionalArea": "",
"additionalStreetType": "",
"additionalStreetShortType": "",
"additionalStreet": "",
"houseType": "дом",
"houseShortType": "д",
"house": "30А",
"houseCheckbox": false,
"houseCheckboxClosed": false,
"building1Type": "",
"building1ShortType": "",
"building1": "",
"building2Type": "",
"building2ShortType": "",
"building2": "",
"apartmentType": "",
"apartmentShortType": "",
"apartment": "",
"apartmentCheckbox": true,
"apartmentCheckboxClosed": false,
"index": "215110",
"geoLat": "55.2257187",
"geoLon": "34.2870146",
"fullAddress": "215110, обл. Смоленская, р-н. Вяземский, г. Вязьма, снт. Восход, д. 30А",
"addressStr": "обл. Смоленская, р-н. Вяземский, г. Вязьма, снт. Восход, д. 30А",
"lat": "55.2257187",
"lng": "34.2870146",
"kladrCode": "6700300100002480001",
"fiasCode": "3a379c2a-e6cf-49be-ac4d-267cc79a8cc3",
"regionFias": "e8502180-6d08-431b-83ea-c7038f0df905",
"regionKladr": "6700000000000",
"townFias": "2e83c695-a150-414c-8f33-c39f2b230bd2",
"townKladr": "67003001000024800",
"streetFias": "",
"streetKladr": "",
"houseFias": "3a379c2a-e6cf-49be-ac4d-267cc79a8cc3",
"houseKladr": "6700300100002480001",
"apartmentFias": "",
"apartmentKladr": "",
"okato": "66205501000",
"oktmo": "66605101001",
"hasErrors": 0,
"regionCode": "67",
"postalCode": "215110",
"oktmoName": "",
"esiaAddressSrt": "215110, обл. Смоленская, г. Вязьма, р-н. Вяземский, снт. Восход, 30А"
},
"registrationData": {}
}
|
Варианты использования
Компонент используется для подтверждения адреса пользователя из ЕСИА. Важно учитывать, что юридический адрес организации вносится в личный кабинет пользователя из данных ФНС и не может быть отредактирован. Поэтому на экране его подтверждения необходим поп-ап «Откуда эти данные и как исправить ошибку». Кроме того, в сценариях подтверждения данных детей можно использовать компонент для подтверждения адреса ребёнка.