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..1] Описание пользователя системы
  • Если регистриуется новый пользователь, то uuid и login не указываются.
  • Если существующий пользователь привязывается к ХС, то указывается uuid или login. Остальные поля в случае указания будут проигнорированы.
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] Тип документа
  • Возможные значения: 17, 18, 19, 20, 21, 22
 <vd:type>17</vd:type>
17 ······</vd:identity>
18 ······<vd:citizenship> vd:Citizenship [1..1] Гражданство пользователя
  • Обязательно к указанию только при регистрации нового пользователя
19 ·········<vd:country> dt:Country [1..1] Страна
  • Обязательно должен быть указан один из идентификаторов: uuid или guid; при указании обоих приоритет у uuid.
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 [1..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:modifyBusinessEntityResponse>
2 ···<merc:businessEntity> dt:BusinessEntity [1..2] Данные о хозяйствующем субъекте.
  • В случае изменения в ответе вернутся две записи: старая и новая
3 ······<bs:uuid> bs:UUID [1..1] Идентификатор версии хозяйствующего субъекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
4 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
5 ······<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
6 ······<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
7 ······<bs:status> bs:VersionStatus [1..1] Статус версии хозяйствующего субъекта. <bs:status>230</bs:status>
8 ······<bs:createDate> xs:DateTime [1..1] Дата создания хозяйствующего субъекта. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
9 ······<bs:updateDate> xs:DateTime [1..1] Дата изменения хозяйствующего субъекта. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
10 ······<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра хозяйствующих субъектов. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
11 ······<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра хозяйствующих субъектов. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
12 ······<dt:type> dt:BusinessEntityType [1..1] Тип создаваемого или редактируемого хозяйствующего субъекта:
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
 <dt:type>1</dt:type>
13 ······<dt:name> bs:String255 [0..1] Наименование хозяйствующего субъекта без указания организационно-правовой формы.
  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
 <dt:name>Гладиолус</dt:name>
14 ······<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма хозяйствующего субъекта.
15 ·········<bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
16 ·········<dt:name> bs:String255 [1..1] Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:name>Общество с ограниченной ответственностью</dt:name>
17 ·········<dt:code> bs:String255 [1..1] Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. <dt:code>12300</dt:code>
18 ·········<dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия. <dt:shortName>ООО</dt:shortName>
19 ······</dt:incorporationForm>
20 ······<dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. <dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
21 ······<dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя.
  • Для юридических лиц поле не возвращается.
 <dt:fio>Иванов Сергей Петрович</dt:fio>
22 ······<dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта. <dt:inn>3312200096</dt:inn>
23 ······<dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП). <dt:kpp>163501001</dt:kpp>
24 ······<dt:ogrn> bs:String255 [0..1] ОГРН или ОГРНИП.
  • Для ИП ОГРНИП может быть не указано.
 <dt:ogrn>4085022240002</dt:ogrn>
25 ······<dt:juridicalAddress> dt:Address [1..1] Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
26 ·········<dt:country> dt:Country [1..1] Страна
27 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
28 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
29 ············<dt:name> bs:String255 [1..1] Наименование страны в соответствии со справочником РСХН. <dt:name>Российская Федерация</dt:name>
30 ·········</dt:country>
31 ·········<dt:region> dt:Region [1..1] Регион
32 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны в соответствии со справочником РСХН. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
33 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны в соответствии со справочником РСХН. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
34 ············<dt:name> bs:String255 [1..1] Наименование региона страны в соответствии со справочником РСХН. <dt:name>Владимирская область</dt:name>
35 ·········</dt:region>
36 ·········<dt:district> dt:Locality [0..1] Район региона
37 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона в соответствии со справочником РСХН. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
38 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
39 ············<dt:name> bs:String255 [1..1] Наименование района региона в соответствии со справочником РСХН. <dt:name>Собинский район</dt:name>
40 ·········</dt:district>
41 ·········<dt:locality> dt:Locality [0..1] Населённый пункт
42 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
43 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
44 ············<dt:name> bs:String255 [1..1] Наименование города региона (города регионального подчинения) страны в соответствии со справочником РСХН. <dt:name>Владимир г</dt:name>
45 ·········</dt:locality>
46 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
47 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
48 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
49 ············<dt:name> bs:String255 [1..1] Наименование населенного пункта в соответствии со справочником РСХН. <dt:name>Энергетик мкрн</dt:name>
50 ·········</dt:subLocality>
51 ·········<dt:street> dt:Street [0..1] Улица
52 ············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор улицы города страны в соответствии со справочником РСХН. <bs:uuid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:uuid>
53 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы города в соответствии со справочником РСХН. <bs:guid>b014d26b-5391-c852-caa4-60fc9bb0a7d4</bs:guid>
54 ············<dt:name> bs:String255 [1..1] Наименование улицы города в соответствии со справочником РСХН. <dt:name>Энергетиков ул</dt:name>
55 ·········</dt:street>
56 ·········<dt:house> bs:String255 [0..1] Номер дома. <dt:house>6</dt:house>
57 ·········<dt:building> bs:String255 [0..1] Номер строения. <dt:building>1</dt:building>
58 ·········<dt:room> bs:String255 [0..1] Номер квартиры / офиса. <dt:room>1</dt:room>
59 ·········<dt:postIndex> bs:String255 [0..1] Почтовый индекс. <dt:postIndex>600037</dt:postIndex>
60 ·········<dt:postBox> bs:String255 [0..1] Абонентский ящик <dt:postBox>а/я 56</dt:postBox>
61 ·········<dt:additionalInfo> bs:String255 [0..1] Дополнительная информация. <dt:additionalInfo>Доп. инфо</dt:additionalInfo>
62 ·········<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
63 ······</dt:juridicalAddress>
64 ···</merc:businessEntity>
65 </merc:modifyBusinessEntityResponse>

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

Поиск или создание нового хозяйствующего субъекта

Поиск и добавление в случае отсутствия нового ХС
<SOAP-ENV:Envelope xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" 
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-10-15T13:25:17</apl:issueDate>
        <apl:data>
          <merc:modifyBusinessEntityRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <merc:modificationOperation>
              <vd:type>FIND_OR_CREATE</vd:type>
              <vd:resultingList>
                <dt:businessEntity>
                  <dt:type>1</dt:type>
                  <dt:name>Макаров и компания</dt:name>
                  <dt:incorporationForm>
                    <bs:uuid>f381ed23-8afd-447b-8c45-652a1d6c2d0b</bs:uuid>
                  </dt:incorporationForm>
                  <dt:fullName>Общество с ограниченной ответственностью "Макаров и компания"</dt:fullName>
                  <dt:inn>3307012700</dt:inn>
                  <dt:ogrn>1000000000263</dt:ogrn>
                  <dt:juridicalAddress>
                    <dt:country>
                      <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                    </dt:country>
                    <dt:region>
                      <bs:guid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</bs:guid>
                    </dt:region>
                    <dt:locality>
                      <bs:guid>0d7d5d87-f0a6-428f-b655-d3be106c64a2</bs:guid>
                    </dt:locality>
                    <dt:addressView>600021, обл.Владимирская, г.Муром, ул.Октябрьской Революции,д.2Б</dt:addressView>
                  </dt:juridicalAddress>
                </dt:businessEntity>
              </vd:resultingList>
              <vd:reason>Причина добавления субъекта в реестр. Например, сведения о контракте с поставщиком или получателем продукции.</vd:reason>
            </merc:modificationOperation>
          </merc:modifyBusinessEntityRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Ответ на запрос 1.
<env:Envelope xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" 
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/">
  <env:Header/>
  <env:Body>
    <apldef:receiveApplicationResultResponse>
      <apl:application>
        <apl:applicationId>9fc40807-37d9-4cba-8170-5e83dab20c11</apl:applicationId>
        <apl:status>COMPLETED</apl:status>
        <apl:serviceId>mercury-g2b.service</apl:serviceId>
        <apl:issuerId>Id</apl:issuerId>
        <apl:issueDate>2017-10-15T13:25:17.000+03:00</apl:issueDate>
        <apl:rcvDate>2017-10-15T13:25:17.000+03:00</apl:rcvDate>
        <apl:prdcRsltDate>2017-10-15T13:25:17.000+03:00</apl:prdcRsltDate>
        <apl:result>
          <merc:modifyBusinessEntityResponse>
            <merc:businessEntity>
              <bs:uuid>da435085-d8d3-4c02-988f-82828f43c55d</bs:uuid>
              <bs:guid>04f35c17-1d26-44c4-8397-69b5936e5fcf</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2014-03-05T14:57:37+04:00</bs:createDate>
              <bs:updateDate>2014-03-05T14:57:37+04:00</bs:updateDate>
              <dt:type>1</dt:type>
              <dt:fullName>ООО "Макаров и компания"</dt:fullName>
              <dt:inn>3307012700</dt:inn>
              <dt:juridicalAddress>
                <dt:country>
                  <bs:uuid>72a84b51-5c5e-11e1-b9b7-001966f192f1</bs:uuid>
                  <bs:guid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</bs:guid>
                  <dt:name>Российская Федерация</dt:name>
                </dt:country>
                <dt:region>
                  <bs:uuid>18489346-08c0-41f4-9a46-b9d1f5a819d9</bs:uuid>
                  <bs:guid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</bs:guid>
                  <dt:name>Владимирская область</dt:name>
                </dt:region>
                <dt:addressView>602254, г. Муром, ул. Привокзальная, д.2</dt:addressView>
              </dt:juridicalAddress>
            </merc:businessEntity>
          </merc:modifyBusinessEntityResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>
Источник — http://help.vetrf.ru/index.php?title=AddBussinessEntityUser_v2&oldid=22543