AddBussinessEntityUser v2.0

Материал из Справочная система Россельхознадзора
Перейти к: навигация, поиск

Содержание

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

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

При выполнении операции на вход системы передаются следующие сведения:

  • информация о пользователе - инициаторе запроса;
  • имя пользователя или уникальный идентификатор, если существующий пользователь привязывается к ХС;
  • данные пользователя (ФИО, паспортные данные, гражданство, адрес электронной почты), если регистрируется новый пользователь;
  • при регистрации нового пользователя опционально могут быть переданы дополнительные данные пользователя (телефон, рабочий телефон, рабочий адрес электронной почты и т.д.), которые будут сохранены в системе "Ветис.Паспорт";
  • при регистрации нового пользователя опционально может быть передан список прав пользователя, но назначены эти права будут после активации созданного пользователя.

Результатом выполнения данной операции является:

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



Возможные сценарии

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_FRESH_MILK_CERTIFICATE Оформление ВСД на сырое молоко (при наличии справки о безопасности сырого молока)
MERCURY_HS_AUTHORIZED_APPLICANT Авторизованный заявитель в системе Меркурий
MERCURY_RETURNED_CERTIFICATE_CREATION Оформление возвратных ВСД

Список доступных ролей также можно получить с помощью операции - 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:workPhone>23-23-25</vd:workPhone> bs:String255 [0..1] Рабочий телефон пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
027 ······<vd:email>1511440241708@yandex.ru</vd:email> bs:String255 [0..1] Адрес электронной почты пользователя
  • Обязательно к указанию только при регистрации нового пользователя
028 ······<vd:workEmail>34833784001f@yandex.ru</vd:workEmail> bs:String255 [0..1] Рабочий адрес электронной почты пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
029 ······<vd:post>Должность</vd:post> bs:String255 [0..1] Должность пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
030 ······<vd:authorityList> vd:AuthorityList [0..1] Список ролей пользователя (опционально)
  • Может быть указано только при регистрации нового пользователя
031 ·········<vd:authority> vd:UserAuthority [1..*] Роль пользователя
032 ············<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> xs:NCName [1..1] Идентификатор роли пользователя
033 ·········</vd:authority>
034 ······</vd:authorityList>
035 ···</vd:user>
036 </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:workPhone>23-23-25</vd:workPhone> bs:String255 [0..1] Рабочий телефон пользователя
009 ······<vd:workEmail>mail@mail.ru</vd:workEmail> bs:String255 [0..1] Рабочий адрес электронной почты пользователя
010 ······<vd:post>Должность</vd:post> bs:String255 [0..1] Должность пользователя
011 ······<vd:authorityList> vd:AuthorityList [0..1] Список ролей пользователя
012 ·········<vd:authority> vd:UserAuthority [1..*] Роль пользователя
013 ············<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> xs:NCName [1..1] Идентификатор роли пользователя
014 ············<vd:name>Авторизованный заявитель в системе Меркурий</vd:name> bs:String255 [1..1] Описание роли пользователя
015 ·········</vd:authority>
016 ······</vd:authorityList>
017 ···</vd:user>
018 </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>


Справочная система Россельхознадзора
Личные инструменты
Пространства имён

Варианты
Действия
Навигация
Печать/экспорт