GetBusinessEntityUserList v2.0

Материал из Справочная система Россельхознадзора
(Различия между версиями)
Перейти к: навигация, поиск
(Используемые пространства имен и типы)
(Спецификация запроса)
Строка 55: Строка 55:
 
|-
 
|-
 
|1
 
|1
|style="font-weight: bold; font-family: Courier;" |<merc:getBusinessEntityUserRequest>
+
|style="font-weight: bold; font-family: Courier;" |<merc:getBusinessEntityUserListRequest>
 
|
 
|
 
|
 
|
Строка 91: Строка 91:
 
|-
 
|-
 
|6
 
|6
|style="font-weight: bold; font-family: Courier;" |···<vd:user>
+
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
|[[User_v2.0|vd:User]]
+
|[[ListOptions|bs:ListOptions]]
|[1..1]
+
|[0..1]
|Описание пользователя системы
+
|Параметры запрашиваемого списка.
* Обязательно указывать или uuid или login пользователя
+
 
|style="font-family: Courier;" |
 
|style="font-family: Courier;" |
 
|-
 
|-
 
|7
 
|7
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
+
|style="font-weight: bold; font-family: Courier;" |······<bs:count>
|[[UUID|bs:UUID]]  
+
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
 
|[0..1]
 
|[0..1]
|Уникальный идентификатор пользователя
+
|Максимальное запрашиваемое количество объектов в списке.
|style="font-family: Courier;" |<bs:uuid>138712f8-823a-4184-b58e-863cc2af18cf</bs:uuid>
+
* По умолчанию значение 100;
 +
* Максимально возможное значение 1000.
 +
|style="font-family: Courier;" |<bs:count>10</bs:count>
 
|-
 
|-
 
|8
 
|8
|style="font-weight: bold; font-family: Courier;" |······<vd:login>
+
|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
+
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
 
|[0..1]
 
|[0..1]
|Логин пользователя
+
|Номер элемента, по которому осуществляется смещение первого элемента списка.
|style="font-family: Courier;" |<vd:login>ivanov_ii_171105</vd:login>
+
* По умолчанию значение 0.
 +
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
 
|-
 
|-
 
|9
 
|9
|style="font-weight: bold; font-family: Courier;" |···</vd:user>
+
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
 
|
 
|
 
|
 
|
Строка 119: Строка 121:
 
|style="font-family: Courier;" |
 
|style="font-family: Courier;" |
 
|-
 
|-
|10
+
|33
|style="font-weight: bold; font-family: Courier;" |</merc:getBusinessEntityUserRequest>
+
|style="font-weight: bold; font-family: Courier;" |</merc:getBusinessEntityUserListRequest>
 
|
 
|
 
|
 
|

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

Содержание

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

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

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

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

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

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

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

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

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




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




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

# Название XML-элемента Тип Обязат. Описание Пример
1 <merc:getBusinessEntityUserListRequest>
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 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
7 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
<bs:count>10</bs:count>
8 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
<bs:offset>2</bs:offset>
9 ···</bs:listOptions>
33 </merc:getBusinessEntityUserListRequest>

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

# Название 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>


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

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