Компонент в стандартной услуге
Общая информация
Компонент предназначен для подтверждения адреса из ЕСИА. Доступен для граждан, организаций и индивидуальных предпринимателей
Поддерживаемые экраны
Компонент может быть задействован на экране типа:
Внешний вид компонента
В услуге
В конструкторе
Структура компонента ConfirmAddress
ВКУ | JSON |
|
||
№ | В конструкторе | Атрибут | Тип | Описание |
1 | Идентификатор компонента | id | string | Уникальный идентификатор компонента в JSON |
2 | Имя компонента | name | string | Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент |
3 | Тип адреса | addrType | string |
Позволяет выбрать из выпадающего списка тип проверяемого адреса:
|
4 | Название поля с адресом | addressLabel | string | Позволяет задать название поля, в котором отображается проверяемый адрес |
5 | Заголовок | title | string | Позволяет задать заголовок дисклеймера, который будет отображаться, если адреса нет в ЛК |
6 | Текст | value | string | Позволяет задать текст дисклеймера, который будет отображаться, если адреса нет в ЛК |
7 | Цвет | type | string | Позволяет задать цвет дисклеймера, который будет отображаться, если адреса нет в ЛК |
8 | Поле | fieldName | string | Позволяет выбрать тип поля из выпадающего списка, для значения в котором будет создано правило валидации |
9 | Тип валидации | type | string | Позволяет выбрать тип валидации регулярное выражение |
10 | Регулярное выражение | value | string | Позволяет задать шаблон, по которому будет проверяться выбранное значение |
11 | Заголовок ошибки | errorMsg | string | Позволяет задать заголовок дисклеймера красного цвета, который отобразится если выбранное значение не будет соответствовать правилу валидации |
12 | Сообщение об ошибке | errorDesc | string | Позволяет задать текст дисклеймера красного цвета, который отобразится если выбранное значение будет не соответствовать правилу валидации |
13 | Модальные окна с пояснениями | clarifications | object, array | Позволяет раскрыть блок «Настроить модальное окно с пояснением вручную» или сделать список ссылок на пояснительные переходы |
14 | Настроить модальное окно с пояснением вручную | acceptableTypes | additionalProperties | Позволяет настроить модальные окна в подсказке под полем с датой регистрации |
15 | Формат отображаемого адреса | fullAddressShowFrom | string |
Позволяет выбрать формат отображаемого адреса из выпадающего списка:
|
16 | Передавать нормализованный адрес в черновик | needNormalize | boolean | При включении, в случае возвращения на предыдущий экран, для введённого адреса произойдёт нормализация, которая сделает деление по полям, рассчитает индекс и определит координаты. Данная нормализация приведёт адрес в стандартизированную форму. По умолчанию нормализация адреса выключена |
17 | Дополнить поля адреса литерой, комнатой или земельным участком | letterRoomEnabled | boolean | Позволяет дополнить адрес литерой, комнатой и земельным участком |
18 | Проверка наличия адреса в ГАР | verifyInGar | boolean | Позволяет осуществить проверку наличия адреса в ГАР, результаты проверки запишутся в черновик |
19 | Поля ЕСИА и dadata | response | string, array | Позволяет указать массив полей из адресных объектов, полученных из ЕСИА или из dadata при нормализации, которые запишутся в черновик |
20 | Модальные окна с пояснениями | clarifications | object, array | Позволяет раскрыть блок «Настроить модальное окно с пояснением вручную» или сделать список ссылок на пояснительные переходы |
21 | Настроить модальное окно с пояснением вручную | acceptableTypes | additionalProperties | Позволяет настроить модальные окна |
Пример JSON структуры компонента передаваемой в DTO
{ "visited": true, "value": "{ "address":{ "regionType":"город", "regionShortType":"г", "region":"Москва", "cityType":"", "cityShortType":"", "city":"", "districtType":"", "districtShortType":"", "district":"", "townType":"", "townShortType":"", "town":"", "additionalTownType":"", "additionalTownShortType":"", "additionalTown":"", "inCityDistType":"", "inCityDistShortType":"", "inCityDist":"", "streetType":"проспект", "streetShortType":"пр-кт", "street":"Мира", "additionalAreaType":"", "additionalAreaShortType":"", "additionalArea":"", "additionalStreetType":"", "additionalStreetShortType":"", "additionalStreet":"", "houseType":"дом", "houseShortType":"д", "house":"5", "houseCheckbox":false, "houseCheckboxClosed":false, "building1Type":"корпус", "building1ShortType":"к", "building1":"1", "building2Type":"", "building2ShortType":"", "building2":"", "apartmentType":"квартира", "apartmentShortType":"кв", "apartment":"2", "litera":"", "literaType":"", "literaShortType":"", "room":"", "roomType":"", "roomShortType":"", "stead":"", "steadType":"", "steadShortType":"", "apartmentCheckbox":false, "apartmentCheckboxClosed":false, "index":"129090", "geoLat":"55.7742879", "geoLon":"37.6319352", "fullAddress":"129090, г. Москва, пр-кт. Мира, д. 5, к. 1, кв. 2", "addressStr":"г. Москва, пр-кт. Мира, д. 5, к. 1, кв. 2", "lat":"55.7742879", "lng":"37.6319352", "kladrCode":"7700000000018560090", "fiasCode":"a087c8dd-04e1-4ded-9a7e-dd75d284e538", "regionFias":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "regionKladr":"7700000000000", "townFias":"", "townKladr":"", "streetFias":"3caaf7f1-9b17-457b-93b2-b8afe9e9aa98", "streetKladr":"77000000000185600", "houseFias":"7e1d514f-7093-4a7b-8bb2-8998f8b4024a", "houseKladr":"7700000000018560090", "apartmentFias":"a087c8dd-04e1-4ded-9a7e-dd75d284e538", "apartmentKladr":"7700000000018560090", "okato":"45286570000", "oktmo":"45379000", "hasErrors":0, "regionCode":"77", "postalCode":"129090", "oktmoName":"", "esiaAddressSrt":"129090, г. Москва, пр-кт. Мира, 5, 1, 2", "esiaFullAddress":"г. Москва, пр-кт. Мира, д 5 к 1, кв 2" }, "registrationData":{} } |
Варианты использования
Компонент используется для подтверждения адреса пользователя из ЕСИА. Важно учитывать, что юридический адрес организации вносится в личный кабинет пользователя из данных ФНС и не может быть отредактирован. Поэтому на экране его подтверждения необходим поп-ап «Откуда эти данные и как исправить ошибку»
Компонент в услуге Робота Макса
Общая информация
Компонент предназначен для подтверждения адреса из ЕСИА. Доступен для граждан (физических лиц)
Поддерживаемые экраны
Компонент может быть задействован на экране типа:
Внешний вид компонента
В услуге Робота Макса
В конструкторе
Структура компонента ConfirmAddress
ВКУ | JSON |
|
||
№ | В конструкторе | Атрибут | Тип | Описание |
1 | Идентификатор компонента | id | string | Уникальный идентификатор компонента в JSON |
2 | Имя компонента | name | string | Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент |
3 | Тип адреса | addrType | string |
Позволяет выбрать из выпадающего списка тип проверяемого адреса:
|
4 | Название поля с адресом | addressLabel | string | Позволяет задать название поля, в котором отображается проверяемый адрес |
5 |
Подсказка по компоненту, отображаемая под адресом | editHint | string |
Подсказка по компоненту, отображаемая под адресом. Должна уведомлять,, что кнопка "Изменить" переведет в ЛК и редактирование адреса будет там. После этого можно будет вернуться в услугу и продолжить ее получение.
Рекомендуемый текст подсказки можно запросить у команды РМ |
6 |
Кастомная подсказка по услуге, отображаемая под адресом | additionalHint | string | Кастомная подсказка по услуге, отображаемая под адресом |
7 | Заголовок | title | string | Позволяет задать заголовок дисклеймера, который будет отображаться, если адреса нет в ЛК |
8 | Текст | value | string | Позволяет задать текст дисклеймера, который будет отображаться, если адреса нет в ЛК |
9 | Цвет | type | string | Позволяет задать цвет дисклеймера, который будет отображаться, если адреса нет в ЛК |
10 | Формат отображаемого адреса | fullAddressShowFrom | string |
Позволяет выбрать формат отображаемого адреса из выпадающего списка:
|
11 | Модальные окна с пояснениями | clarifications | object, array | Позволяет раскрыть блок «Настроить модальное окно с пояснением вручную» |
12 | Настроить модальное окно с пояснением вручную | acceptableTypes | additionalProperties | Позволяет настроить модальные окна в подсказке под полем с датой регистрации |
Пример JSON структуры компонента передаваемой в DTO
{ "visited": true, "value": "{ "address":{ "regionType":"город", "regionShortType":"г", "region":"Москва", "cityType":"", "cityShortType":"", "city":"", "districtType":"", "districtShortType":"", "district":"", "townType":"", "townShortType":"", "town":"", "additionalTownType":"", "additionalTownShortType":"", "additionalTown":"", "inCityDistType":"", "inCityDistShortType":"", "inCityDist":"", "streetType":"проспект", "streetShortType":"пр-кт", "street":"Мира", "additionalAreaType":"", "additionalAreaShortType":"", "additionalArea":"", "additionalStreetType":"", "additionalStreetShortType":"", "additionalStreet":"", "houseType":"дом", "houseShortType":"д", "house":"5", "houseCheckbox":false, "houseCheckboxClosed":false, "building1Type":"корпус", "building1ShortType":"к", "building1":"1", "building2Type":"", "building2ShortType":"", "building2":"", "apartmentType":"квартира", "apartmentShortType":"кв", "apartment":"2", "litera":"", "literaType":"", "literaShortType":"", "room":"", "roomType":"", "roomShortType":"", "stead":"", "steadType":"", "steadShortType":"", "apartmentCheckbox":false, "apartmentCheckboxClosed":false, "index":"129090", "geoLat":"55.7742879", "geoLon":"37.6319352", "fullAddress":"129090, г. Москва, пр-кт. Мира, д. 5, к. 1, кв. 2", "addressStr":"г. Москва, пр-кт. Мира, д. 5, к. 1, кв. 2", "lat":"55.7742879", "lng":"37.6319352", "kladrCode":"7700000000018560090", "fiasCode":"a087c8dd-04e1-4ded-9a7e-dd75d284e538", "regionFias":"0c5b2444-70a0-4932-980c-b4dc0d3f02b5", "regionKladr":"7700000000000", "townFias":"", "townKladr":"", "streetFias":"3caaf7f1-9b17-457b-93b2-b8afe9e9aa98", "streetKladr":"77000000000185600", "houseFias":"7e1d514f-7093-4a7b-8bb2-8998f8b4024a", "houseKladr":"7700000000018560090", "apartmentFias":"a087c8dd-04e1-4ded-9a7e-dd75d284e538", "apartmentKladr":"7700000000018560090", "okato":"45286570000", "oktmo":"45379000", "hasErrors":0, "regionCode":"77", "postalCode":"129090", "oktmoName":"", "esiaAddressSrt":"129090, г. Москва, пр-кт. Мира, 5, 1, 2", "esiaFullAddress":"г. Москва, пр-кт. Мира, д 5 к 1, кв 2" }, "registrationData":{} } |
Варианты использования
Из-за особенностей диалогового режима в Робота Макса на данный момент нет возможности на одном экране отобразить и адрес, и период (дату) регистрации с возможностью ее редактирования. Поэтому, если нужно, чтобы пользователь указал ее лично (для постоянной регистрации) - необходимо использовать компонент DateInput . Функционал Робота Макса поддерживает экраны с несколькими компонентами, поэтому DateInput можно прописать на одном экране с ConfirmAddress, либо добавить на следующий экран