AddBussinessEntityUser v2: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''ModifyBusinessEntityOperation''' предназначена для регистрации новых хозя…»)
 
м (Nikeshina-ad-171025 переименовал страницу AddBussinessEntityUser v2.0 в AddBussinessEntityUser v2)
 
(не показаны 44 промежуточные версии 5 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==
Операция '''ModifyBusinessEntityOperation''' предназначена для регистрации новых хозяйствующих субъектов в реестре, а так же для изменения информации об уже зарегистрированных.  
Операция '''AddBussinessEntityUser''' предназначена для регистрации новых пользователей в системе Меркурий или привязки существующих пользователей к хозяйствующему субъекту.
Хозяйствующий субъект может быть трех типов:
* юридическое лицо;
'''При выполнении операции на вход системы передаются следующие сведения:'''
* индивидуальный предприниматель/КФХ;
:* информация о пользователе - инициаторе запроса;
* физическое лицо.  
:* имя пользователя или уникальный идентификатор, если существующий пользователь привязывается к ХС;
:* данные пользователя (ФИО, паспортные данные, гражданство, адрес электронной почты), если регистрируется новый пользователь;
:* при регистрации нового пользователя опционально могут быть переданы дополнительные данные пользователя (телефон, рабочий телефон, рабочий адрес электронной почты и т.д.), которые будут сохранены в системе "Ветис.Паспорт";
:* при регистрации нового пользователя опционально может быть передан список прав пользователя, но назначены эти права будут после активации созданного пользователя.


Реестр хозяйствующих субъектов ведется с применением версионирования, это означает, что запись об одном лице может иметь несколько версий. При каждом изменении записи реестра создается новая версия этой записи. То есть при регистрации нового хозяйствующего субъекта создаётся новая запись, а если информация о хозяйствующем субъекте изменяется, то в реестр вносится ещё одна версия записи.  
'''Результатом выполнения данной операции является:'''
:* регистрация нового пользователя или привязка существующего пользователя к хозяйствующему субъекту.
<br />


Идентификация  каждой  записи  производится  по следующим полям:
{{ambox
* GUID - глобальный идентификатор записи. Данный идентификатор остается неизменным для всех версий записи о хозяйствующем субъекте.
|type      = warning
* UUID - идентификатор версии записи. Данный идентификатор изменяется для каждой новой версии записи о хозяйствующем субъекте.
|text      = '''ОБРАТИТЕ ВНИМАНИЕ:'''
При создании каждой новой версии записи о хозяйствующем субъекте, старая версия записи становится неактивной и должна ссылаться на новую версию, а новая — на старую. Таким образом, возможно восстановить историю изменений.  
|text-small = Необходимо указывать существующий активный адрес электронной почты (поле email). На указанную в запросе электронную почту придет письмо с назначенным временным паролем и персональной ссылкой для активации и смены временного пароля на постоянный. Без выполнения активации пользователь не сможет работать в системе Меркурий.
Для одной записи журнала может существовать только одна актуальная версия.
}}


В рамках операции '''ModifyBusinessEntityOperation''' доступны следующие действия:
===Возможные сценарии===
* создание нового хозяйствующего субъекта;
'''1. Регистрация нового пользователя (в запросе не передаются uuid или login).'''
* поиск существующей или добавление новой записи о хозяйствующем субъекте в реестр;
:1.1. В запросе переданы данные уже существующего в системе пользователя:
* редактирование сведений о хозяйствующем субъекте.  
::* Если в запросе переданы уже существующие в системе паспортные данные, то вернется отказ в выполнении операции.
::* Если в запросе передан уже существующий в системе адрес электронной почты, то вернется отказ в выполнении операции.
:1.2. В запросе переданы данные отсутствующего в системе пользователя:
::* Будет создан новый пользователь, все указанные данные будут переданы в систему "Ветис.Паспорт".
::* В ответе будет передано сгенерированное имя пользователя (login).
::* На указанный в запросе email будет отправлено письмо с информацией о регистрации нового пользователя, временным паролем для входа, ссылкой для активации пользователя и смены пароля.
::* Пользователь будет привязан к хозяйствующему субъекту.
:1.3. Некорректный запрос.
:1.4. Внутренняя ошибка системы.
'''2. Привязка существующего пользователя к хозяйствующему субъекту (в запросе передаются uuid или login).'''
:2.1. В запросе передан существующий в системе пользователь:
::* Пользователь будет привязан к хозяйствующему субъекту.
:2.2. В запросе передан отсутствующий в системе пользователь:
::* Отказ в выполнении операции.
:2.3. Некорректный запрос.
:2.4. Внутренняя ошибка системы.
<br />
{{ambox
|type      = notice
|text      = '''Инициатор запроса'''
|text-small = Инициатор запроса должен иметь связь с хозяйствующем субъектом, к которому привязывается указываемый в запросе пользователь. Для выполнения операций по добавлению пользователей инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".
}}
{{ambox
|type      = notice
|text      = '''Регистрация или привязка списка пользователей'''
|text-small = Операция поддерживает регистрацию списка новых пользователей или привязку списка существующих пользователей к хозяйствующему субъекту.
}}


При выполнении операции '''ModifyBusinessEntityOperation''' на вход системы передаются следующие сведения:
===Список доступных для назначения ролей===
* информация о пользователе - инициаторе запроса;
* тип операции (добавление, поиск или изменение);
* информация о хозяйствующем субъекте (организационно-правовая форма, ИНН, ОГРН, КПП  и другие данные, характеризующие организацию или физическое лицо).


Результатом выполнения данной операции в зависимости от типа операции является:
На данный момент доступен для назначения следующий список прав:
* добавление записи о новом хозяйствующем субъекте в реестре;
* внесение изменений в существующую запись.


===Возможные сценарии===
{| class="wikitable"
При выполнении операции возможны следующие сценарии:<br />
|-
1. Создание хозяйствующего субъекта.
! ID роли !! Наименование роли
:1.1. Запрос успешно обработан. В реестре зарегистрирован один из трех типов хозяйствующих субъектов:<br />
|-
::* <div id ="legalEntity">юридическое лицо;</div>
| '''MERCURY_ACCESS_WEB_READ''' || Доступ к веб-интерфейсу ИС Меркурий только на чтение
::* <div id = "physicalPerson">физическое лицо;</div>
|-
::* <div id="entrepreneur">индивидуальный предприниматель. </div>
| '''MERCURY_ACCESS_WEB_WRITE''' || Доступ к веб-интерфейсу ИС Меркурий на выполнение операций
:1.2. Ошибка обработки запроса, в случае, если хозяйствующих субъект с указанными данными уже существует.  
|-
:1.3. Некорректный запрос.
| '''ARGUS_HS_AUTHORIZED_APPLICANT''' || Авторизованный заявитель в системе Аргус
:1.4. Внутренняя ошибка системы.
|-
<div id="changeData">2. Изменение данных хозяйствующего субъекта.</div>
| '''MERCURY_ACCESS_API_READ''' || Доступ к ИС Меркурий через Ветис.API только на чтение
:2.1. Запрос успешно обработан. Данные хозяйствующего субъекта изменены.<br />
|-
:2.2. Произошла ошибка при обработке запроса.
| '''MERCURY_CONTROL_WORKING_AREA''' || Управление зонами ответственности пользователей
:: • Некорректный запрос.
|-
:: • Внутренняя ошибка системы.
| '''MERCURY_ACCESS_API_WRITE''' || Доступ к ИС Меркурий через Ветис.API на выполнение операций
<div id="search">3. Поиск хозяйствующего субъекта по ИНН и ОГРН. Пользователь передает сведения о хозяйствующем субъекте и в реестре осуществляется поиск по этим данным. В случае, если запрашиваемый хозяйствующий субъект уже существует (проверка осуществляется по ОГРН), то пользователю возвращается информация об этом хозяйствующем субъекте. Если хозяйствующего субъекта с указанными данными нет в реестре, то в реестр добавляется соответствующая запись.</div>
|-
:3.1. Запрос успешно обработан. Данные хозяйствующего субъекта изменены.<br />
| '''MERCURY_CERTIFICATE_ACCEPTANCE''' || Гашение ВСД
:3.2. Произошла ошибка при обработке запроса.
|-
:: • Некорректный запрос.
| '''MERCURY_AUTHORIZED_CERTIFICATE_ACCEPTANCE''' || Уполномоченное гашение ВСД
:: • Внутренняя ошибка системы.
|-
| '''MERCURY_AUTHORIZED_RETURNED_CERTIFICATE_CREATION''' || Уполномоченное оформление возвратных ВСД
|-
| '''MERCURY_HS_FISH_CERTIFICATE''' || Сертификация уловов ВБР
|-
| '''MERCURY_PRODUCTION_BATCH_CERTIFICATE''' || Оформление ВСД на производственную партию
|-
| '''MERCURY_HS_AUTHORIZED_APPLICANT''' || Авторизованный заявитель в системе Меркурий
|-
| '''MERCURY_RETURNED_CERTIFICATE_CREATION''' || Оформление возвратных ВСД
|-
| '''MERCURY_HS_AUTHORIZED_646''' || Уполномоченное лицо (Оформление ВСД на продукцию из Приказа МСХ РФ № 646)
|-
| '''MERCURY_HS_FRESH_MILK_CERTIFICATE''' || Оформление ВСД на сырое молоко (при наличии справки о безопасности сырого молока)
|-
| '''MERCURY_CREATE_INVENTORY_ACT''' || Создание акта инвентаризации
|-
| '''MERCURY_CREATE_COLLATION_ACT''' || Создание акта сверки
|-
| '''MERCURY_CREATE_DECOMMISSION_ACT''' || Создание акта списания
|}
 
'''Список доступных ролей также можно получить с помощью операции - [[GetApplicableUserAuthorityList_v2.0|getApplicableUserAuthorityList]].'''


===Используемые пространства имен ===
===Используемые пространства имен и типы===
{{столбцы}}
{{столбцы}}
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2|vd]] (<nowiki>http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2</nowiki>)
** [[AuthorityList_v2.0|vd:AuthorityList]]
** [[Citizenship_v2.0|vd:Citizenship]]
** [[Document_v2.0|vd:Document]]
** [[SNILSType_v2.0|vd:SNILSType]]
** [[UserAuthority_v2.0|vd:UserAuthority]]
** [[User_v2.0|vd:User]]
{{столбец}}
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[RegisterModificationType_v2.0|bs:RegisterModificationType]]
** [[String255|bs:String255]]
** [[String255|bs:String255]]
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
** [[VersionStatus|bs:VersionStatus]]


* [[NameSpaces#http://api.vetrf.ru/schema/cdm/dictionary|dt]] (<nowiki>http://api.vetrf.ru/schema/cdm/dictionary</nowiki>)
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/dictionary/v2|dt]] (<nowiki>http://api.vetrf.ru/schema/cdm/dictionary/v2</nowiki>)
** [[Address_v2.0|dt:Address]]
** [[BusinessEntity_v2.0|dt:BusinessEntity]]
** [[BusinessEntityList_v2.0|dt:BusinessEntityList]]
** [[BusinessEntityType_v2.0|dt:BusinessEntityType]]
** [[Country_v2.0|dt:Country]]
** [[Country_v2.0|dt:Country]]
** [[IncorporationForm_v2.0|dt:IncorporationForm]]
** [[DocumentType_v2.0|dt:DocumentType]]
** [[Locality_v2.0|dt:Locality]]
 
** [[Region_v2.0|dt:Region]]
** [[Street_v2.0|dt:Street]]
** [[User_v2.0|dt:User]]
{{столбец}}
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/mercury/vet-document|vd]] (<nowiki>http://api.vetrf.ru/schema/cdm/mercury/vet-document</nowiki>)
** [[BEModificationOperation_v2.0|vd:BEModificationOperation]]
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
** [http://www.w3.org/TR/xmlschema-2/#DateTime xs:date]
** [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
** [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]


{{столбцы/конец}}
{{столбцы/конец}}
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}addBusinessEntityUserRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|merc:}}localTransactionId>'''}}{{color|#131313|А0001}}{{color|#190dbf|'''</{{color|#660e7a|merc:}}localTransactionId>'''}}
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|[1..1]
| style="width:52em;"| Идентификатор заявки в клиентской системе.
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|merc:}}initiator>'''}}
|[[User_v2.0|vd:User]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Является ответственным за выполнение бизнес-операции.
* Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.</div>
</div>
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|user_ab_150101}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|[1..1]
| style="width:52em;"| Логин пользователя, зарегистрированного в системе Меркурий.
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|merc:}}initiator>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}}
|[[User_v2.0|vd:User]]
|[1..*]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Описание пользователя системы.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Если регистриуется новый пользователь, то uuid и login не указываются.
* Если существующий пользователь привязывается к ХС, то указывается uuid или login. Остальные поля в случае указания будут проигнорированы.</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"| Уникальный идентификатор пользователя
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|ivanov_ii_171105}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|[0..1]
| style="width:52em;"| Логин пользователя
|-
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}firstName>'''}}{{color|#131313|Иван}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}firstName>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Имя
* Обязательно к указнию только при регистрации нового пользователя
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}middleName>'''}}{{color|#131313|Иванович}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}middleName>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Отчество
* Обязательно к указанию только при регистрации нового пользователя
|-
|011
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}lastName>'''}}{{color|#131313|Иванов}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}lastName>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Фамилия
* Обязательно к указанию только при регистрации нового пользователя
|-
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}birthDate>'''}}{{color|#131313|1987-01-02}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}birthDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#date xs:date]
|[0..1]
| style="width:52em;"| Дата рождения
* Обязательно к указанию только при регистрации нового пользователя
|-
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}identity>'''}}
|[[Document_v2.0|vd:Document]]
|[0..1]
| style="width:52em;"| Документ, удостоверяющий личность
* Обязательно к указанию только при регистрации нового пользователя
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}issueSeries>'''}}{{color|#131313|1511}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}issueSeries>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Серия документа
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}issueNumber>'''}}{{color|#131313|241708}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}issueNumber>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Номер документа
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}type>'''}}{{color|#131313|17}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}type>'''}}
|[[DocumentType_v2.0|dt:DocumentType]]
|[1..1]
| style="width:52em;"| Тип документа
* Возможные значения: 17, 18, 19, 20, 21, 22
|-
|017
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}identity>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}citizenship>'''}}
|[[Citizenship_v2.0|vd:Citizenship]]
|[0..1]
| style="width:52em;"| Гражданство пользователя
* Обязательно к указанию только при регистрации нового пользователя
|-
|019
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}country>'''}}
|[[Country_v2.0|dt:Country]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Страна</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Обязательно должен быть указан один из идентификаторов: uuid или guid; при указании обоих приоритет у uuid.</div>
</div>
|-
|020
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"| Уникальный идентификатор страны в соответствии со справочником РСХН.
|-
|021
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"| Глобальный идентификатор страны в соответствии со справочником РСХН.
|-
|022
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}country>'''}}
|
|
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}citizenship>'''}}
|
|
| style="width:52em;"|
|-
|024
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}snils>'''}}{{color|#131313|123-123-123 12}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}snils>'''}}
|[[SNILSType_v2.0|vd:SNILSType]]
|[0..1]
| style="width:52em;"| СНИЛС (опционально)
* Может быть указано только при регистрации нового пользователя
|-
|025
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}phone>'''}}{{color|#131313|23-23-23}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}phone>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Телефон пользователя (опционально)
* Может быть указано только при регистрации нового пользователя
|-
|026
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}email>'''}}{{color|#131313|1511440241708@yandex.ru}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}email>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Адрес электронной почты пользователя
* Обязательно к указанию только при регистрации нового пользователя
|-
|027
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}workEmail>'''}}{{color|#131313|34833784001f@yandex.ru}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}workEmail>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Рабочий адрес электронной почты пользователя (опционально)
* Может быть указано только при регистрации нового пользователя
|-
|028
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}post>'''}}{{color|#131313|Должность}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}post>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Должность пользователя (опционально)
* Может быть указано только при регистрации нового пользователя
|-
|029
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}authorityList>'''}}
|[[AuthorityList_v2.0|vd:AuthorityList]]
|[0..1]
| style="width:52em;"| Список ролей пользователя (опционально)
* Может быть указано только при регистрации нового пользователя
|-
|030
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}authority>'''}}
|[[UserAuthority_v2.0|vd:UserAuthority]]
|[1..*]
| style="width:52em;"| Роль пользователя
|-
|031
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}ID>'''}}{{color|#131313|MERCURY_AUTHORIZED_APPLICANT}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}ID>'''}}
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|[1..1]
| style="width:52em;"| Идентификатор роли пользователя
|-
|032
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}authority>'''}}
|
|
| style="width:52em;"|
|-
|033
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}authorityList>'''}}
|
|
| style="width:52em;"|
|-
|034
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}}
|
|
| style="width:52em;"|
|-
|035
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}addBusinessEntityUserRequest>'''}}
|
|
| style="width:52em;"|
|-
|}
==Спецификация ответа==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}addBusinessEntityUserResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}}
|[[User_v2.0|vd:User]]
|[1..*]
| style="width:52em;"| Описание пользователя системы
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
| style="width:52em;"| Уникальный идентификатор пользователя
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|ivanov_ii_171105}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|[1..1]
| style="width:52em;"| Логин пользователя
|-
|005
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}firstName>'''}}{{color|#131313|Иван}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}firstName>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Имя
|-
|006
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}middleName>'''}}{{color|#131313|Иванович}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}middleName>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Отчество
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}lastName>'''}}{{color|#131313|Иванов}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}lastName>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Фамилия
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}workEmail>'''}}{{color|#131313|mail@mail.ru}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}workEmail>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Рабочий адрес электронной почты пользователя
|-
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}post>'''}}{{color|#131313|Должность}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}post>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Должность пользователя
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}authorityList>'''}}
|[[AuthorityList_v2.0|vd:AuthorityList]]
|[0..1]
| style="width:52em;"| Список ролей пользователя
|-
|011
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}authority>'''}}
|[[UserAuthority_v2.0|vd:UserAuthority]]
|[1..*]
| style="width:52em;"| Роль пользователя
|-
|012
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}ID>'''}}{{color|#131313|MERCURY_AUTHORIZED_APPLICANT}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}ID>'''}}
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|[1..1]
| style="width:52em;"| Идентификатор роли пользователя
|-
|013
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}name>'''}}{{color|#131313|Авторизованный заявитель в системе Меркурий}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}name>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Описание роли пользователя
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}authority>'''}}
|
|
| style="width:52em;"|
|-
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}authorityList>'''}}
|
|
| style="width:52em;"|
|-
|016
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}addBusinessEntityUserResponse>'''}}
|
|
| style="width:52em;"|
|-
|}
==Примеры запросов==
===Регистрация нового пользователя===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id = "scenario5">Регистрация нового пользователя</div>
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2"
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08</apl:issueDate>
        <apl:data>
          <merc:addBusinessEntityUserRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <vd:user>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02</vd:birthDate>
              <vd:identity>
                <vd:issueSeries>1508</vd:issueSeries>
                <vd:issueNumber>436542</vd:issueNumber>
                <vd:type>17</vd:type>
              </vd:identity>
              <vd:citizenship>
                <vd:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                </vd:country>
              </vd:citizenship>
              <vd:email>1508871436542@yandex.ru</vd:email>
            </vd:user>
          </merc:addBusinessEntityUserRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</syntaxhighlight>
</div>
</div>
<br/>
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id = "scenario5">Ответ на запрос</div>
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<env:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2"
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>ecd5b39a-7bbf-41c5-adfe-a92259b72584</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-11-08T10:32:07.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-11-08T10:32:08.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:addBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>6c2eb90a-b717-4075-8093-32d59b684452</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
              <vd:email>1508871436542@yandex.ru</vd:email>
            </vd:user>
          </merc:addBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>
</syntaxhighlight>
</div>
</div>
<br/>
===Привязка существующего пользователя к хозяйствующему субъекту===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id = "scenario5">Привязка существующего пользователя к хозяйствующему субъекту</div>
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2"
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08</apl:issueDate>
        <apl:data>
          <merc:addBusinessEntityUserRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <vd:user>
              <vd:login>ivanov_ii_171108</vd:login>
            </vd:user>
          </merc:addBusinessEntityUserRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</syntaxhighlight>
</div>
</div>
<br/>
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id = "scenario5">Ответ на запрос</div>
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<env:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2"
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>ecd5b39a-7bbf-41c5-adfe-a92259b72584</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-11-08T10:32:07.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-11-08T10:32:08.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:addBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>2732beec-c3f5-4024-892a-1c92fca663f3</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
            </vd:user>
          </merc:addBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>
</syntaxhighlight>
</div>
</div>
<br/>
===Регистрация списка новых пользователей===
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id = "scenario5">Привязка существующего пользователя к хозяйствующему субъекту</div>
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2"
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08</apl:issueDate>
        <apl:data>
          <merc:addBusinessEntityUserRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <vd:user>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02</vd:birthDate>
              <vd:identity>
                <vd:issueSeries>1512</vd:issueSeries>
                <vd:issueNumber>061952</vd:issueNumber>
                <vd:type>17</vd:type>
              </vd:identity>
              <vd:citizenship>
                <vd:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                </vd:country>
              </vd:citizenship>
              <vd:email>1512053061952@yandex.ru</vd:email>
            </vd:user>
            <vd:user>
              <vd:firstName>Петр</vd:firstName>
              <vd:middleName>Петрович</vd:middleName>
              <vd:lastName>Петров</vd:lastName>
              <vd:birthDate>1987-01-02</vd:birthDate>
              <vd:identity>
                <vd:issueSeries>1508</vd:issueSeries>
                <vd:issueNumber>636157</vd:issueNumber>
                <vd:type>17</vd:type>
              </vd:identity>
              <vd:citizenship>
                <vd:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                </vd:country>
              </vd:citizenship>
              <vd:email>1508171636157@yandex.ru</vd:email>
            </vd:user>
          </merc:addBusinessEntityUserRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</syntaxhighlight>
</div>
</div>
<br/>
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id = "scenario5">Ответ на запрос</div>
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<env:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2"
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
xmlns:apl="http://api.vetrf.ru/schema/cdm/application"
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>ecd5b39a-7bbf-41c5-adfe-a92259b72584</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-11-08T10:32:07.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-11-08T10:32:08.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:addBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>80b3835a-5669-4f28-b383-ab11bc0a6cc1</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
              <vd:email>1512053061952@yandex.ru</vd:email>
              <vd:workEmail>1512053061952@yandex.ru</vd:workEmail>
            </vd:user>
            <vd:user>
              <bs:uuid>c207f427-9252-4e84-89d8-fe4532374234</bs:uuid>
              <vd:login>petrov_pp_171108</vd:login>
              <vd:firstName>Петр</vd:firstName>
              <vd:middleName>Петрович</vd:middleName>
              <vd:lastName>Петров</vd:lastName>
              <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
              <vd:email>1508171636157@yandex.ru</vd:email>
              <vd:workEmail>1508171636157@yandex.ru</vd:workEmail>
            </vd:user>
          </merc:addBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>
</syntaxhighlight>
</div>
</div>
<br/>
[[Category:Ветис.API]]

Текущая версия на 12:08, 1 июня 2023

Общие сведения

Операция 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. Внутренняя ошибка системы.


Информация
 Инициатор запроса
Инициатор запроса должен иметь связь с хозяйствующем субъектом, к которому привязывается указываемый в запросе пользователь. Для выполнения операций по добавлению пользователей инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".


Информация
 Регистрация или привязка списка пользователей
Операция поддерживает регистрацию списка новых пользователей или привязку списка существующих пользователей к хозяйствующему субъекту.


Список доступных для назначения ролей

На данный момент доступен для назначения следующий список прав:

ID роли Наименование роли
MERCURY_ACCESS_WEB_READ Доступ к веб-интерфейсу ИС Меркурий только на чтение
MERCURY_ACCESS_WEB_WRITE Доступ к веб-интерфейсу ИС Меркурий на выполнение операций
ARGUS_HS_AUTHORIZED_APPLICANT Авторизованный заявитель в системе Аргус
MERCURY_ACCESS_API_READ Доступ к ИС Меркурий через Ветис.API только на чтение
MERCURY_CONTROL_WORKING_AREA Управление зонами ответственности пользователей
MERCURY_ACCESS_API_WRITE Доступ к ИС Меркурий через Ветис.API на выполнение операций
MERCURY_CERTIFICATE_ACCEPTANCE Гашение ВСД
MERCURY_AUTHORIZED_CERTIFICATE_ACCEPTANCE Уполномоченное гашение ВСД
MERCURY_AUTHORIZED_RETURNED_CERTIFICATE_CREATION Уполномоченное оформление возвратных ВСД
MERCURY_HS_FISH_CERTIFICATE Сертификация уловов ВБР
MERCURY_PRODUCTION_BATCH_CERTIFICATE Оформление ВСД на производственную партию
MERCURY_HS_AUTHORIZED_APPLICANT Авторизованный заявитель в системе Меркурий
MERCURY_RETURNED_CERTIFICATE_CREATION Оформление возвратных ВСД
MERCURY_HS_AUTHORIZED_646 Уполномоченное лицо (Оформление ВСД на продукцию из Приказа МСХ РФ № 646)
MERCURY_HS_FRESH_MILK_CERTIFICATE Оформление ВСД на сырое молоко (при наличии справки о безопасности сырого молока)
MERCURY_CREATE_INVENTORY_ACT Создание акта инвентаризации
MERCURY_CREATE_COLLATION_ACT Создание акта сверки
MERCURY_CREATE_DECOMMISSION_ACT Создание акта списания

Список доступных ролей также можно получить с помощью операции - getApplicableUserAuthorityList.

Используемые пространства имен и типы



Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:addBusinessEntityUserRequest>
002 ···<merc:localTransactionId>А0001</merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе.
003 ···<merc:initiator> vd:User [1..1]

Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу.

  • Является ответственным за выполнение бизнес-операции.
  • Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
004 ······<vd:login>user_ab_150101</vd:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий.
005 ···</merc:initiator>
006 ···<vd:user> vd:User [1..*]

Описание пользователя системы.

  • Если регистриуется новый пользователь, то uuid и login не указываются.
  • Если существующий пользователь привязывается к ХС, то указывается uuid или login. Остальные поля в случае указания будут проигнорированы.
007 ······<bs:uuid>UUID</bs:uuid> bs:UUID [0..1] Уникальный идентификатор пользователя
008 ······<vd:login>ivanov_ii_171105</vd:login> xs:NCName [0..1] Логин пользователя
009 ······<vd:firstName>Иван</vd:firstName> bs:String255 [0..1] Имя
  • Обязательно к указнию только при регистрации нового пользователя
010 ······<vd:middleName>Иванович</vd:middleName> bs:String255 [0..1] Отчество
  • Обязательно к указанию только при регистрации нового пользователя
011 ······<vd:lastName>Иванов</vd:lastName> bs:String255 [0..1] Фамилия
  • Обязательно к указанию только при регистрации нового пользователя
012 ······<vd:birthDate>1987-01-02</vd:birthDate> xs:date [0..1] Дата рождения
  • Обязательно к указанию только при регистрации нового пользователя
013 ······<vd:identity> vd:Document [0..1] Документ, удостоверяющий личность
  • Обязательно к указанию только при регистрации нового пользователя
014 ·········<vd:issueSeries>1511</vd:issueSeries> bs:String255 [1..1] Серия документа
015 ·········<vd:issueNumber>241708</vd:issueNumber> bs:String255 [1..1] Номер документа
016 ·········<vd:type>17</vd:type> dt:DocumentType [1..1] Тип документа
  • Возможные значения: 17, 18, 19, 20, 21, 22
017 ······</vd:identity>
018 ······<vd:citizenship> vd:Citizenship [0..1] Гражданство пользователя
  • Обязательно к указанию только при регистрации нового пользователя
019 ·········<vd:country> dt:Country [1..1]

Страна

  • Обязательно должен быть указан один из идентификаторов: uuid или guid; при указании обоих приоритет у uuid.
020 ············<bs:uuid>UUID</bs:uuid> bs:UUID [0..1] Уникальный идентификатор страны в соответствии со справочником РСХН.
021 ············<bs:guid>GUID</bs:guid> bs:UUID [0..1] Глобальный идентификатор страны в соответствии со справочником РСХН.
022 ·········</vd:country>
023 ······</vd:citizenship>
024 ······<vd:snils>123-123-123 12</vd:snils> vd:SNILSType [0..1] СНИЛС (опционально)
  • Может быть указано только при регистрации нового пользователя
025 ······<vd:phone>23-23-23</vd:phone> bs:String255 [0..1] Телефон пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
026 ······<vd:email>1511440241708@yandex.ru</vd:email> bs:String255 [0..1] Адрес электронной почты пользователя
  • Обязательно к указанию только при регистрации нового пользователя
027 ······<vd:workEmail>34833784001f@yandex.ru</vd:workEmail> bs:String255 [0..1] Рабочий адрес электронной почты пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
028 ······<vd:post>Должность</vd:post> bs:String255 [0..1] Должность пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
029 ······<vd:authorityList> vd:AuthorityList [0..1] Список ролей пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
030 ·········<vd:authority> vd:UserAuthority [1..*] Роль пользователя
031 ············<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> xs:NCName [1..1] Идентификатор роли пользователя
032 ·········</vd:authority>
033 ······</vd:authorityList>
034 ···</vd:user>
035 </merc:addBusinessEntityUserRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:addBusinessEntityUserResponse>
002 ···<vd:user> vd:User [1..*] Описание пользователя системы
003 ······<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Уникальный идентификатор пользователя
004 ······<vd:login>ivanov_ii_171105</vd:login> xs:NCName [1..1] Логин пользователя
005 ······<vd:firstName>Иван</vd:firstName> bs:String255 [1..1] Имя
006 ······<vd:middleName>Иванович</vd:middleName> bs:String255 [0..1] Отчество
007 ······<vd:lastName>Иванов</vd:lastName> bs:String255 [1..1] Фамилия
008 ······<vd:workEmail>mail@mail.ru</vd:workEmail> bs:String255 [0..1] Рабочий адрес электронной почты пользователя
009 ······<vd:post>Должность</vd:post> bs:String255 [0..1] Должность пользователя
010 ······<vd:authorityList> vd:AuthorityList [0..1] Список ролей пользователя
011 ·········<vd:authority> vd:UserAuthority [1..*] Роль пользователя
012 ············<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> xs:NCName [1..1] Идентификатор роли пользователя
013 ············<vd:name>Авторизованный заявитель в системе Меркурий</vd:name> bs:String255 [1..1] Описание роли пользователя
014 ·········</vd:authority>
015 ······</vd:authorityList>
016 ···</vd:user>
017 </merc:addBusinessEntityUserResponse>

Примеры запросов

Регистрация нового пользователя

Регистрация нового пользователя
<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" 
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" 
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" 
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08</apl:issueDate>
        <apl:data>
          <merc:addBusinessEntityUserRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <vd:user>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02</vd:birthDate>
              <vd:identity>
                <vd:issueSeries>1508</vd:issueSeries>
                <vd:issueNumber>436542</vd:issueNumber>
                <vd:type>17</vd:type>
              </vd:identity>
              <vd:citizenship>
                <vd:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                </vd:country>
              </vd:citizenship>
              <vd:email>1508871436542@yandex.ru</vd:email>
            </vd:user>
          </merc:addBusinessEntityUserRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Ответ на запрос
<env:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" 
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" 
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>ecd5b39a-7bbf-41c5-adfe-a92259b72584</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-11-08T10:32:07.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-11-08T10:32:08.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:addBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>6c2eb90a-b717-4075-8093-32d59b684452</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
              <vd:email>1508871436542@yandex.ru</vd:email>
            </vd:user>
          </merc:addBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>


Привязка существующего пользователя к хозяйствующему субъекту

Привязка существующего пользователя к хозяйствующему субъекту
<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" 
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" 
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" 
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08</apl:issueDate>
        <apl:data>
          <merc:addBusinessEntityUserRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <vd:user>
              <vd:login>ivanov_ii_171108</vd:login>
            </vd:user>
          </merc:addBusinessEntityUserRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Ответ на запрос
<env:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" 
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" 
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>ecd5b39a-7bbf-41c5-adfe-a92259b72584</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-11-08T10:32:07.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-11-08T10:32:08.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:addBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>2732beec-c3f5-4024-892a-1c92fca663f3</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
            </vd:user>
          </merc:addBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>


Регистрация списка новых пользователей

Привязка существующего пользователя к хозяйствующему субъекту
<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" 
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" 
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" 
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08</apl:issueDate>
        <apl:data>
          <merc:addBusinessEntityUserRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <vd:user>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02</vd:birthDate>
              <vd:identity>
                <vd:issueSeries>1512</vd:issueSeries>
                <vd:issueNumber>061952</vd:issueNumber>
                <vd:type>17</vd:type>
              </vd:identity>
              <vd:citizenship>
                <vd:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                </vd:country>
              </vd:citizenship>
              <vd:email>1512053061952@yandex.ru</vd:email>
            </vd:user>
            <vd:user>
              <vd:firstName>Петр</vd:firstName>
              <vd:middleName>Петрович</vd:middleName>
              <vd:lastName>Петров</vd:lastName>
              <vd:birthDate>1987-01-02</vd:birthDate>
              <vd:identity>
                <vd:issueSeries>1508</vd:issueSeries>
                <vd:issueNumber>636157</vd:issueNumber>
                <vd:type>17</vd:type>
              </vd:identity>
              <vd:citizenship>
                <vd:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                </vd:country>
              </vd:citizenship>
              <vd:email>1508171636157@yandex.ru</vd:email>
            </vd:user>
          </merc:addBusinessEntityUserRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Ответ на запрос
<env:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" 
xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
xmlns:apl="http://api.vetrf.ru/schema/cdm/application" 
xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>ecd5b39a-7bbf-41c5-adfe-a92259b72584</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-11-08T10:32:08.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-11-08T10:32:07.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-11-08T10:32:08.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:addBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>80b3835a-5669-4f28-b383-ab11bc0a6cc1</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
              <vd:firstName>Иван</vd:firstName>
              <vd:middleName>Иванович</vd:middleName>
              <vd:lastName>Иванов</vd:lastName>
              <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
              <vd:email>1512053061952@yandex.ru</vd:email>
              <vd:workEmail>1512053061952@yandex.ru</vd:workEmail>
            </vd:user>
            <vd:user>
              <bs:uuid>c207f427-9252-4e84-89d8-fe4532374234</bs:uuid>
              <vd:login>petrov_pp_171108</vd:login>
              <vd:firstName>Петр</vd:firstName>
              <vd:middleName>Петрович</vd:middleName>
              <vd:lastName>Петров</vd:lastName>
              <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
              <vd:email>1508171636157@yandex.ru</vd:email>
              <vd:workEmail>1508171636157@yandex.ru</vd:workEmail>
            </vd:user>
          </merc:addBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>


Источник — http://help.vetrf.ru/index.php?title=AddBussinessEntityUser_v2&oldid=37202