GetBusinessEntityUserList v2.0

Материал из Справочная система Россельхознадзора
(Различия между версиями)
Перейти к: навигация, поиск
(Спецификация запроса)
(Спецификация ответа)
Строка 135: Строка 135:
 
! Тип
 
! Тип
 
! Обязат.
 
! Обязат.
! Описание
+
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
+
 
|-
 
|-
|1
+
|001
|style="font-weight: bold; font-family: Courier;" |<merc:getBusinessEntityUserListResponse>
+
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}getBusinessEntityUserListResponse>'''}}
 
|
 
|
 
|
 
|
|
+
| style="width:52em;"|  
|style="font-family: Courier;" |
+
 
|-
 
|-
|2
+
|002
|style="font-weight: bold; font-family: Courier;" |···<vd:userList>
+
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}userList {{color|Red|total&#61;}}{{color|#007f15|"123"}} {{color|Red|offset&#61;}}{{color|#007f15|"0"}} {{color|Red|count&#61;}}{{color|#007f15|"100"}}>'''}}
 
|[[UserList_v2.0|vd:UserList]]
 
|[[UserList_v2.0|vd:UserList]]
 
|[1..1]
 
|[1..1]
|Список пользователей
+
| style="width:52em;"| Список пользователей
|style="font-family: Courier;" |
+
 
|-
 
|-
|3
+
|003
|style="font-weight: bold; font-family: Courier;" |······<vd:user>
+
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}}
 
|[[User_v2.0|vd:User]]
 
|[[User_v2.0|vd:User]]
 
|[0..*]
 
|[0..*]
|Описание пользователя системы
+
| style="width:52em;"| Описание пользователя системы
|style="font-family: Courier;" |
+
 
|-
 
|-
|4
+
|004
|style="font-weight: bold; font-family: Courier;" |·········<bs:uuid>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
 
|[[UUID|bs:UUID]]  
 
|[[UUID|bs:UUID]]  
 
|[1..1]
 
|[1..1]
|Уникальный идентификатор пользователя
+
| style="width:52em;"| Уникальный идентификатор пользователя
|style="font-family: Courier;" |<bs:uuid>138712f8-823a-4184-b58e-863cc2af18cf</bs:uuid>
+
 
|-
 
|-
|5
+
|005
|style="font-weight: bold; font-family: Courier;" |·········<vd:login>
+
|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]
 
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
 
|[1..1]
 
|[1..1]
|Логин пользователя
+
| style="width:52em;"| Логин пользователя
|style="font-family: Courier;" |<vd:login>ivanov_ii_171105</vd:login>
+
 
|-
 
|-
|6
+
|006
|style="font-weight: bold; font-family: Courier;" |·········<vd:firstName>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}firstName>'''}}{{color|#131313|Иван}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}firstName>'''}}
 
|[[String255|bs:String255]]
 
|[[String255|bs:String255]]
|[0..1]
+
|[1..1]
|Имя
+
| style="width:52em;"| Имя
|style="font-family: Courier;" |<vd:firstName>Иванов</vd:firstName>
+
 
|-
 
|-
|7
+
|007
|style="font-weight: bold; font-family: Courier;" |·········<vd:middleName>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}middleName>'''}}{{color|#131313|Иванович}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}middleName>'''}}
 
|[[String255|bs:String255]]
 
|[[String255|bs:String255]]
 
|[0..1]
 
|[0..1]
|Отчество
+
| style="width:52em;"| Отчество
|style="font-family: Courier;" |<vd:middleName>Иван</vd:middleName>
+
 
|-
 
|-
|8
+
|008
|style="font-weight: bold; font-family: Courier;" |·········<vd:lastName>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}lastName>'''}}{{color|#131313|Иванов}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}lastName>'''}}
 
|[[String255|bs:String255]]
 
|[[String255|bs:String255]]
|[0..1]
+
|[1..1]
|Фамилия
+
| style="width:52em;"| Фамилия
|style="font-family: Courier;" |<vd:lastName>Иванович</vd:lastName>
+
|-
+
|9
+
|style="font-weight: bold; font-family: Courier;" |·········<vd:birthDate>
+
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
+
|[0..1]
+
|Дата рождения
+
|style="font-family: Courier;" |<vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate>
+
 
|-
 
|-
|10
+
|009
|style="font-weight: bold; font-family: Courier;" |·········<vd:phone>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}workPhone>'''}}{{color|#131313|23-23-25}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}workPhone>'''}}
 
|[[String255|bs:String255]]
 
|[[String255|bs:String255]]
 
|[0..1]
 
|[0..1]
|Телефон пользователя
+
| style="width:52em;"| Рабочий телефон пользователя
|style="font-family: Courier;" |<vd:phone>23-23-23</vd:phone>
+
 
|-
 
|-
|11
+
|010
|style="font-weight: bold; font-family: Courier;" |·········<vd:workPhone>
+
|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]]
 
|[[String255|bs:String255]]
 
|[0..1]
 
|[0..1]
|Рабочий телефон пользователя
+
| style="width:52em;"| Рабочий адрес электронной почты пользователя
|style="font-family: Courier;" |<vd:workPhone>23-23-25</vd:workPhone>
+
 
|-
 
|-
|12
+
|011
|style="font-weight: bold; font-family: Courier;" |·········<vd:email>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}post>'''}}{{color|#131313|Должность}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}post>'''}}
 
|[[String255|bs:String255]]
 
|[[String255|bs:String255]]
 
|[0..1]
 
|[0..1]
|Адрес электронной почты пользователя
+
| style="width:52em;"| Должность пользователя
|style="font-family: Courier;" |<vd:email>1511440241708@yandex.ru</vd:email>
+
 
|-
 
|-
|13
+
|012
|style="font-weight: bold; font-family: Courier;" |·········<vd:workEmail>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}authorityList>'''}}
|[[String255|bs:String255]]
+
|[0..1]
+
|Рабочий адрес электронной почты пользователя
+
|style="font-family: Courier;" |<vd:workEmail>34833784001f@yandex.ru</vd:workEmail>
+
|-
+
|14
+
|style="font-weight: bold; font-family: Courier;" |·········<vd:post>
+
|[[String255|bs:String255]]
+
|[0..1]
+
|Должность пользователя
+
|style="font-family: Courier;" |<vd:post>Должность</vd:post>
+
|-
+
|15
+
|style="font-weight: bold; font-family: Courier;" |·········<vd:authorityList>
+
 
|[[AuthorityList_v2.0|vd:AuthorityList]]
 
|[[AuthorityList_v2.0|vd:AuthorityList]]
 
|[0..1]
 
|[0..1]
|Список ролей пользователя
+
| style="width:52em;"| Список ролей пользователя
|style="font-family: Courier;" |
+
 
|-
 
|-
|16
+
|013
|style="font-weight: bold; font-family: Courier;" |············<vd:authority>
+
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}authority>'''}}
 
|[[UserAuthority_v2.0|vd:UserAuthority]]
 
|[[UserAuthority_v2.0|vd:UserAuthority]]
 
|[1..*]
 
|[1..*]
|Роль пользователя
+
| style="width:52em;"| Роль пользователя
|style="font-family: Courier;" |
+
 
|-
 
|-
|17
+
|014
|style="font-weight: bold; font-family: Courier;" |···············<vd:ID>
+
|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]
 
|[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
 
|[1..1]
 
|[1..1]
|Идентификатор роли пользователя
+
| style="width:52em;"| Идентификатор роли пользователя
|style="font-family: Courier;" |<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID>
+
 
|-
 
|-
|18
+
|015
|style="font-weight: bold; font-family: Courier;" |···············<vd:name>
+
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|vd:}}name>'''}}{{color|#131313|Авторизованный заявитель в системе Меркурий}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}name>'''}}
 
|[[String255|bs:String255]]
 
|[[String255|bs:String255]]
 
|[1..1]
 
|[1..1]
|Описание роли пользователя
+
| style="width:52em;"| Описание роли пользователя
|style="font-family: Courier;" |<vd:name>Авторизованный заявитель в системе Меркурий</vd:name>
+
 
|-
 
|-
|19
+
|016
|style="font-weight: bold; font-family: Courier;" |············</vd:authority>
+
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|vd:}}authority>'''}}
 
|
 
|
 
|
 
|
|
+
| style="width:52em;"|  
|style="font-family: Courier;" |
+
 
|-
 
|-
|20
+
|017
|style="font-weight: bold; font-family: Courier;" |·········</vd:authorityList>
+
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}authorityList>'''}}
|
+
 
|
 
|
 
|
 
|
|style="font-family: Courier;" |
+
| style="width:52em;"|  
 
|-
 
|-
|21
+
|018
|style="font-weight: bold; font-family: Courier;" |······</vd:user>
+
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}}
 
|
 
|
 
|
 
|
|
+
| style="width:52em;"|  
|style="font-family: Courier;" |
+
 
|-
 
|-
|22
+
|019
|style="font-weight: bold; font-family: Courier;" |···</vd:userList>
+
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}userList>'''}}
 
|
 
|
 
|
 
|
|
+
| style="width:52em;"|  
|style="font-family: Courier;" |
+
 
|-
 
|-
|23
+
|020
|style="font-weight: bold; font-family: Courier;" |</merc:getBusinessEntityUserListResponse>
+
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}getBusinessEntityUserListResponse>'''}}
|
+
 
|
 
|
 
|
 
|
|style="font-family: Courier;" |
+
| style="width:52em;"|  
 
|-
 
|-
 
|}
 
|}

Версия 05:14, 2 марта 2018

Содержание

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

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

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

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

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

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

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

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

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




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




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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:getBusinessEntityUserListRequest>
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 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
007 ······<bs:count>10</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке.

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
008 ······<bs:offset>2</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка.

  • По умолчанию значение 0.
009 ···</bs:listOptions>
010 </merc:getBusinessEntityUserListRequest>

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

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

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

Запрос списка пользователей

Запрос списка пользователей

<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:getBusinessEntityUserListRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
            <bs:listOptions>
              <bs:count>100</bs:count>
              <bs:offset>0</bs:offset>
            </bs:listOptions>
          </merc:getBusinessEntityUserListRequest>
        </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:userList>
              <vd:user>
                <bs:uuid>a6c94c59-fbaa-4046-b295-883bc3a27584</bs:uuid>
                <vd:login>auu_aa_171030</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>1509020@yandex.ru</vd:email>
                <vd:workEmail>1509020@yandex.ru</vd:workEmail>
              </vd:user>
              <vd:user>
                <bs:uuid>690ad0ee-e119-4525-a485-eeda53c7bf94</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>1509021549911@yandex.ru</vd:email>
                <vd:workEmail>1509021549911@yandex.ru</vd:workEmail>
              </vd:user>
	    <vd:userList>
          </merc:getBusinessEntityUserResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>


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

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