AddBussinessEntityUser v2
Общие сведения
Операция AddBussinessEntityUser предназначена для регистрации новых пользователей в системе Меркурий или привязки существующих пользователей к хозяйствующему субъекту.
При выполнении операции на вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- имя пользователя или уникальный идентификатор, если существующий пользователь привязывается к ХС;
- данные пользователя (ФИО, паспортные данные, гражданство, адрес электронной почты), если регистрируется новый пользователь;
- при регистрации нового пользователя опционально могут быть переданы дополнительные данные пользователя (телефон, рабочий телефон, рабочий адрес электронной почты и т.д.), которые будут сохранены в системе "Ветис.Паспорт";
- при регистрации нового пользователя опционально может быть передан список прав пользователя, но назначены эти права будут после активации созданного пользователя.
Результатом выполнения данной операции является:
- регистрация нового пользователя или привязка существующего пользователя к хозяйствующему субъекту.
 |
ОБРАТИТЕ ВНИМАНИЕ: Необходимо указывать существующий активный адрес электронной почты (поле email). На указанную в запросе электронную почту придет письмо с назначенным временным паролем и персональной ссылкой для активации и смены временного пароля на постоянный. Без выполнения активации пользователь не сможет работать в системе Меркурий.
|
Возможные сценарии
1. Регистрация нового пользователя (в запросе не передаются uuid или login).
- 1.1. В запросе переданы данные уже существующего в системе пользователя:
- Если в запросе переданы уже существующие в системе паспортные данные, то вернется отказ в выполнении операции.
- Если в запросе передан уже существующий в системе адрес электронной почты, то вернется отказ в выполнении операции.
- 1.2. В запросе переданы данные отсутствующего в системе пользователя:
- Будет создан новый пользователь, все указанные данные будут переданы в систему "Ветис.Паспорт".
- В ответе будет передано сгенерированное имя пользователя (login).
- На указанный в запросе email будет отправлено письмо с информацией о регистрации нового пользователя, временным паролем для входа, ссылкой для активации пользователя и смены пароля.
- Пользователь будет привязан к хозяйствующему субъекту.
- 1.3. Некорректный запрос.
- 1.4. Внутренняя ошибка системы.
2. Привязка существующего пользователя к хозяйствующему субъекту (в запросе передаются uuid или login).
- 2.1. В запросе передан существующий в системе пользователь:
- Пользователь будет привязан к хозяйствующему субъекту.
- 2.2. В запросе передан отсутствующий в системе пользователь:
- Отказ в выполнении операции.
- 2.3. Некорректный запрос.
- 2.4. Внутренняя ошибка системы.
 |
Инициатор запроса Инициатор запроса должен иметь связь с хозяйствующем субъектом, к которому привязывается указываемый в запросе пользователь. Для выполнения операций по добавлению пользователей инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".
|
|
Регистрация или привязка списка пользователей Операция поддерживает регистрацию списка новых пользователей или привязку списка существующих пользователей к хозяйствующему субъекту.
|
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <merc:addBusinessEntityUserRequest> | ||||
| 2 | ···<merc:localTransactionId> | xs:NCName | [1..1] | Идентификатор заявки в клиентской системе. | <bs:guid>A00001</bs:guid> |
| 3 | ···<merc:initiator> | vd:User | [1..1] | Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу.
|
|
| 4 | ······<vd:login> | xs:NCName | [1..1] | Логин пользователя, зарегистрированного в системе Меркурий. | <vd:login>user_ab_150101</vd:login> |
| 5 | ···</merc:initiator> | ||||
| 6 | ···<vd:user> | vd:User | [1..*] | Описание пользователя системы
|
|
| 7 | ······<bs:uuid> | bs:UUID | [0..1] | Уникальный идентификатор пользователя | <bs:uuid>138712f8-823a-4184-b58e-863cc2af18cf</bs:uuid> |
| 8 | ······<vd:login> | xs:NCName | [0..1] | Логин пользователя | <vd:login>ivanov_ii_171105</vd:login> |
| 9 | ······<vd:firstName> | bs:String255 | [0..1] | Имя
|
<vd:firstName>Иванов</vd:firstName> |
| 10 | ······<vd:middleName> | bs:String255 | [0..1] | Отчество
|
<vd:middleName>Иван</vd:middleName> |
| 11 | ······<vd:lastName> | bs:String255 | [0..1] | Фамилия
|
<vd:lastName>Иванович</vd:lastName> |
| 12 | ······<vd:birthDate> | xs:date | [0..1] | Дата рождения
|
<vd:birthDate>1987-01-02</vd:birthDate> |
| 13 | ······<vd:identity> | vd:Document | [0..1] | Документ, удостоверяющий личность
|
|
| 14 | ·········<vd:issueSeries> | bs:String255 | [1..1] | Серия документа | <vd:issueSeries>1511</vd:issueSeries> |
| 15 | ·········<vd:issueNumber> | bs:String255 | [1..1] | Номер документа | <vd:issueNumber>241708</vd:issueNumber> |
| 16 | ·········<vd:type> | dt:DocumentType | [1..1] | Тип документа
|
<vd:type>17</vd:type> |
| 17 | ······</vd:identity> | ||||
| 18 | ······<vd:citizenship> | vd:Citizenship | [1..1] | Гражданство пользователя
|
|
| 19 | ·········<vd:country> | dt:Country | [1..1] | Страна
|
|
| 20 | ············<bs:uuid> | bs:UUID | [0..1] | Уникальный идентификатор страны в соответствии со справочником РСХН. | <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid> |
| 21 | ············<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор страны в соответствии со справочником РСХН. | <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid> |
| 22 | ·········</vd:country> | ||||
| 23 | ······</vd:citizenship> | ||||
| 24 | ······<vd:snils> | vd:SNILSType | [0..1] | СНИЛС (опционально)
|
<vd:snils>123-123-123 12</vd:snils> |
| 25 | ······<vd:phone> | bs:String255 | [0..1] | Телефон пользователя (опционально)
|
<vd:phone>23-23-23</vd:phone> |
| 26 | ······<vd:workPhone> | bs:String255 | [0..1] | Рабочий телефон пользователя (опционально)
|
<vd:workPhone>23-23-25</vd:workPhone> |
| 27 | ······<vd:email> | bs:String255 | [0..1] | Адрес электронной почты пользователя
|
<vd:email>1511440241708@yandex.ru</vd:email> |
| 28 | ······<vd:workEmail> | bs:String255 | [0..1] | Рабочий адрес электронной почты пользователя (опционально)
|
<vd:workEmail>34833784001f@yandex.ru</vd:workEmail> |
| 29 | ······<vd:post> | bs:String255 | [0..1] | Должность пользователя (опционально)
|
<vd:post>Должность</vd:post> |
| 30 | ······<vd:authorityList> | vd:AuthorityList | [0..1] | Список ролей пользователя (опционально)
|
|
| 31 | ·········<vd:authority> | vd:UserAuthority | [1..*] | Роль пользователя | |
| 32 | ············<vd:ID> | xs:NCName | [1..1] | Идентификатор роли пользователя | <vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> |
| 33 | ·········</vd:authority> | ||||
| 34 | ······</vd:authorityList> | ||||
| 35 | ···</vd:user> | ||||
| 36 | </merc:addBusinessEntityUserRequest> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <merc:addBusinessEntityUserResponse> | ||||
| 2 | ···<vd:user> | vd:User | [1..*] | Описание пользователя системы | |
| 3 | ······<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор пользователя | <bs:uuid>138712f8-823a-4184-b58e-863cc2af18cf</bs:uuid> |
| 4 | ······<vd:login> | xs:NCName | [1..1] | Логин пользователя | <vd:login>ivanov_ii_171105</vd:login> |
| 5 | ······<vd:firstName> | bs:String255 | [1..1] | Имя | <vd:firstName>Иванов</vd:firstName> |
| 6 | ······<vd:middleName> | bs:String255 | [1..1] | Отчество | <vd:middleName>Иван</vd:middleName> |
| 7 | ······<vd:lastName> | bs:String255 | [1..1] | Фамилия | <vd:lastName>Иванович</vd:lastName> |
| 8 | ······<vd:birthDate> | xs:date | [1..1] | Дата рождения | <vd:birthDate>1987-01-02</vd:birthDate> |
| 9 | ······<vd:phone> | bs:String255 | [0..1] | Телефон пользователя | <vd:phone>23-23-23</vd:phone> |
| 10 | ······<vd:workPhone> | bs:String255 | [0..1] | Рабочий телефон пользователя | <vd:workPhone>23-23-25</vd:workPhone> |
| 11 | ······<vd:email> | bs:String255 | [1..1] | Адрес электронной почты пользователя | <vd:email>1511440241708@yandex.ru</vd:email> |
| 12 | ······<vd:workEmail> | bs:String255 | [0..1] | Рабочий адрес электронной почты пользователя | <vd:workEmail>34833784001f@yandex.ru</vd:workEmail> |
| 13 | ······<vd:post> | bs:String255 | [0..1] | Должность пользователя | <vd:post>Должность</vd:post> |
| 14 | ······<vd:authorityList> | vd:AuthorityList | [0..1] | Список ролей пользователя | |
| 15 | ·········<vd:authority> | vd:UserAuthority | [1..*] | Роль пользователя | |
| 16 | ············<vd:ID> | xs:NCName | [1..1] | Идентификатор роли пользователя | <vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> |
| 17 | ············<vd:name> | bs:String255 | [1..1] | Описание роли пользователя | <vd:name>Авторизованный заявитель в системе Меркурий</vd:name> |
| 18 | ·········</vd:authority> | ||||
| 19 | ······</vd:authorityList> | ||||
| 20 | ···</vd:user> | ||||
| 21 | </merc:addBusinessEntityUserResponse> |
Примеры запросов
Регистрация нового пользователя
Регистрация нового пользователя
Ответ на запрос
Привязка существующего пользователя к хозяйствующему субъекту
Привязка существующего пользователя к хозяйствующему субъекту
Ответ на запрос
