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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetBusinessEntityUser''' предназначена для получения данных пользоват…»)
 
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==
Операция '''GetBusinessEntityUser''' предназначена для получения данных пользователя по логину или его уникальному идентификатору.
Операция '''GetBusinessEntityUserList''' предназначена для получения списка пользователей хозяйствующего субъекта.
   
   
'''При выполнении операции на вход системы передаются следующие сведения:'''
'''При выполнении операции на вход системы передаются следующие сведения:'''
:* информация о пользователе - инициаторе запроса;  
:* информация о пользователе - инициаторе запроса;  
:* имя пользователя или уникальный идентификатор, если существующий пользователь привязывается к ХС.
:* параметры запрашиваемого списка.


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


===Возможные сценарии===
===Возможные сценарии===
'''1. Получение данных пользователя'''
'''1. Получение списка пользователей'''
:1.1. Запрос успешно обработан.  
:1.1. Запрос успешно обработан.  
:1.2. Произошла ошибка выполнения запроса:
:1.2. Произошла ошибка выполнения запроса:
::* Запрашиваемый пользователь отсутствует в системе.
::* Некорректный запрос.
::* Некорректный запрос.
::* Внутренняя ошибка системы.
::* Внутренняя ошибка системы.
<br />
{{ambox
|type      = notice
|text      = '''Инициатор запроса'''
|text-small = Инициатор запроса должен иметь связь с хозяйствующем субъектом. Для выполнения операций по получению данных пользователей инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".
}}
<br />
<br />
{{ambox
{{ambox

Версия 15:06, 9 ноября 2017

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

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

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

  • информация о пользователе - инициаторе запроса;
  • параметры запрашиваемого списка.

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

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

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

1. Получение списка пользователей

1.1. Запрос успешно обработан.
1.2. Произошла ошибка выполнения запроса:
  • Некорректный запрос.
  • Внутренняя ошибка системы.


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



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


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



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

# Название XML-элемента Тип Обязат. Описание Пример
1 <merc:getBusinessEntityUserRequest>
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 пользователя
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:user>
10 </merc:getBusinessEntityUserRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <merc:getBusinessEntityUserResponse>
2 ···<vd:user> vd:User [1..1] Описание пользователя системы
3 ······<bs:uuid> bs:UUID [1..1] Уникальный идентификатор пользователя <bs:uuid>138712f8-823a-4184-b58e-863cc2af18cf</bs:uuid>
4 ······<vd:login> xs:NCName [1..1] Логин пользователя <vd:login>ivanov_ii_171105</vd:login>
5 ······<vd:firstName> bs:String255 [0..1] Имя <vd:firstName>Иванов</vd:firstName>
6 ······<vd:middleName> bs:String255 [0..1] Отчество <vd:middleName>Иван</vd:middleName>
7 ······<vd:lastName> bs:String255 [0..1] Фамилия <vd:lastName>Иванович</vd:lastName>
8 ······<vd:birthDate> xs:date [0..1] Дата рождения <vd:birthDate>1987-01-02</vd:birthDate>
9 ······<vd:phone> bs:String255 [0..1] Телефон пользователя <vd:phone>23-23-23</vd:phone>
10 ······<vd:workPhone> bs:String255 [0..1] Рабочий телефон пользователя <vd:workPhone>23-23-25</vd:workPhone>
11 ······<vd:email> bs:String255 [0..1] Адрес электронной почты пользователя <vd:email>1511440241708@yandex.ru</vd:email>
12 ······<vd:workEmail> bs:String255 [0..1] Рабочий адрес электронной почты пользователя <vd:workEmail>34833784001f@yandex.ru</vd:workEmail>
13 ······<vd:post> bs:String255 [0..1] Должность пользователя <vd:post>Должность</vd:post>
14 ······<vd:authorityList> vd:AuthorityList [0..1] Список ролей пользователя
15 ·········<vd:authority> vd:UserAuthority [1..*] Роль пользователя
16 ············<vd:ID> xs:NCName [1..1] Идентификатор роли пользователя <vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID>
17 ············<vd:name> bs:String255 [1..1] Описание роли пользователя <vd:name>Авторизованный заявитель в системе Меркурий</vd:name>
18 ·········</vd:authority>
19 ······</vd:authorityList>
20 ···</vd:user>
21 </merc:getBusinessEntityUserResponse>

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

Запрос пользователя по login

Запрос пользователя по login 

<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:getBusinessEntityUserRequest>
            <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:getBusinessEntityUserRequest>
        </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:getBusinessEntityUserResponse>
            <vd:user>
              <bs:uuid>16676f0a-faf7-4025-909b-01f91de64ad3</bs:uuid>
              <vd:login>ivanov_ii_171108</vd:login>
              <vd:authorityList>
                <vd:authority>
                  <vd:ID>MERCURY_PRODUCTION_BATCH_CERTIFICATE</vd:ID>
                  <vd:name>Оформление ВСД на производственную партию</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_API_WRITE</vd:ID>
                  <vd:name>Доступ к ИС Меркурий через Ветис.API на выполнение операций</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_RETURNED_CERTIFICATE_CREATION</vd:ID>
                  <vd:name>Оформление возвратных ВСД</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_CONTROL_WORKING_AREA</vd:ID>
                  <vd:name>Управление зонами ответственности пользователей</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_WEB_READ</vd:ID>
                  <vd:name>Доступ к веб-интерфейсу ИС Меркурий только на чтение</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_CERTIFICATE_ACCEPTANCE</vd:ID>
                  <vd:name>Гашение ВСД</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_API_READ</vd:ID>
                  <vd:name>Доступ к ИС Меркурий через Ветис.API только на чтение</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_HS_AUTHORIZED_APPLICANT</vd:ID>
                  <vd:name>Авторизованный заявитель в системе Меркурий</vd:name>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_WEB_WRITE</vd:ID>
                  <vd:name>Доступ к веб-интерфейсу ИС Меркурий на выполнение операций</vd:name>
                </vd:authority>
              </vd:authorityList>
              <vd:authorityList>
                <vd:authority>
                  <vd:ID>ARGUS_HS_AUTHORIZED_APPLICANT</vd:ID>
                  <vd:name>Авторизованный заявитель в системе Аргус</vd:name>
                </vd:authority>
              </vd:authorityList>
            </vd:user>
          </merc:getBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>


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