Общая информация
Компонент позволяет ввести реквизиты паспорта РФ, загранпаспорта РФ, паспорта иностранного гражданина или свидетельства о рождении.
Поддерживаемые экраны
Компонент может быть задействован на экране типа:
Внешний вид компонента
В услуге
В конструкторе
Структура компонента PassportLookup
ВКУ |
JSON |
|||
№ |
В конструкторе |
Атрибут |
Тип |
Описание |
1 |
Идентификатор компонента |
id |
string |
Уникальный идентификатор компонента в JSON |
2 |
Удобочитаемое имя компонента |
Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера – сгенерированные идентификаторы, s – экран, c – компонент |
||
3 |
Заголовок компонента |
label |
string |
Название поля. Заполнение необязательно, так как есть заголовок по умолчанию |
4 |
Поле является обязательным для заполнения? |
Принуждает к взаимодействию с компонентом | ||
5 |
Атрибут устанавливать true, если валидация входных параметров не должна происходить |
skipValidation |
boolean |
Регулирует валидацию входных параметров |
6 |
Идентификатор подсказки/саджеста/suggest |
suggestionId |
string |
Статья по саджестам |
|
Дополнительные атрибуты компонента | attrs | object |
|
7 |
Заголовок компонента |
title |
string |
Заголовок компонента. По умолчанию создаётся заголовок «Паспорт РФ» |
8 |
Скрыть заголовок? |
titleHide |
boolean |
Если true, то скрывает заголовок компонента. Например, когда заполнено поле label |
9 |
Тип документа, по которому осуществляется поиск |
docType |
string |
Выпадающий список с возможностью выбрать тип документа, реквизиты которого будут валидироваться компонентом. Включает: Паспорт РФ, Загранпаспорт, Паспорт иностранного гражданина, Свидетельство о рождении |
10 |
Поля |
fields |
array |
Массив объектов, в котором можно добавить поля «Серия» и «Номер». Добавленному полю можно установить лейбл, сообщение об ошибке, регулярное выражение и маску ввода. Без регулярного выражения и маски компонент не будет валидироваться |
11 |
Название атрибута |
fieldName |
string |
Позволяет выбрать название поля для ввода: Серия или Номер |
12 |
Подпись поля |
label |
string |
Позволяет ввести подпись поля. По умолчанию соответствует названию выбранного атрибута |
13 |
Подставляет пример эталонного значения в поле для ввода |
placeholder |
string |
Позволяет отображать в поле пример заполнения серым текстом |
14 | Сообщение об ошибке, отображаемое, если правило валидации не выполняется | errorMsg | string | По умолчанию подставляет текст в зависимости от атрибута: Для серии – поле должно содержать 4 цифры, Для номера – поле должно содержать 6 цифр |
15 | Регулярное выражение | regexp | string | Позволяет указать регулярное выражение для поля. По умолчанию подставляет выражение в зависимости от атрибута: для серии - ^[0-9]{4}$, для номера - ^[0-9]{6}$ |
16 | Маска ввода | mask | array | Позволяет указать маску ввода для поля. Маска обязательна для проверки на существование серии или номера |
17 | Настройка формирования health-метрик | healthList | array | Позволяет задать список событий компонента, по которым будут формироваться health-запросы |
|
Поля для проверки | compare_rows | object |
|
18 | ID компонента, в котором содержится Имя искомого пользователя | firstName | string | Позволяет проверить соответствие серии и номер паспорта, и имени пользователя |
19 | ID компонента, в котором содержится Фамилия искомого пользователя | lastName | string | Позволяет проверить соответствие серии и номера паспорта, и фамилию пользователя |
20 | Экраны для проверки | compare_rows_screens | array | Позволяет ввести идентификатор экранов, на которых содержатся поля имени и фамилии, с которыми сверяется компонент |
21 |
|
personFields | array |
Список возвращаемых полей по найденному пользователю. По умолчанию, если список не задать, то вернутся все поля. Возможные значения: oid, snils, firstName, lastName, middleName, birthDate, gender, rfPasportSeries, rfPasportNumber, exists |
|
Ограничение запросов поиска пользователя | rateLimit | object |
|
22 | Количество попыток | limit | number | Позволяет ограничить количество запросов от пользователя |
23 | Интервал времени, в секундах | ttl | number | Позволяет ограничить время на запросы от пользователя |
24 | Установить зависимость с ранее введёнными данными | ref | array | Массив объектов, в элементах которых описываются зависимости и правила отображения полей |
25 | Вычисляемые аргументы компонента (linkenValues) | linkedValues | array | Атрибуты компонента, позволяющие реализовать сложный функционал |
Пример JSON структуры компонента передаваемой в DTO
{ “visited”: true, “value”: { “rfPasportSeries”: “0000”, “rfPasportNumber”: “000000”, “oid”: “1000000000”, “snils”: “000-111-22241”, “firstName”: “Иван”, “lastName”: “Иванов”, “middleName”: “Иванович”, “birthDate”: “1997-08-04”, “gender”: “M”, “exists”: true } } |
Варианты использования
Компонент используется для ввода паспортных данных и автоматической проверки их существования в ЕСИА. В отдельных случаях с данными ЕСИА могут сравниваться не только реквизиты паспорта, но и имя и фамилия гражданина.