GetBusinessEntityUserList v2: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 51: | Строка 51: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}getBusinessEntityUserListRequest>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |002 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|merc:}}localTransactionId>'''}}{{color|#131313|А0001}}{{color|#190dbf|'''</{{color|#660e7a|merc:}}localTransactionId>'''}} | ||
|[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=" | |||
|- | |- | ||
| | |003 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|merc:}}initiator>'''}} | ||
|[[User_v2.0|vd:User]] | |[[User_v2.0|vd:User]] | ||
|[1..1] | |[1..1] | ||
|Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. | |<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | ||
* Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт. | <span style="white-space:nowrap; font-weight: normal;">Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу.</span> | ||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* Является ответственным за выполнение бизнес-операции. | |||
* Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.</div> | |||
</div> | |||
|- | |- | ||
| | |004 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|user_ab_150101}}{{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;"| Логин пользователя, зарегистрированного в системе Меркурий. | ||
|- | |- | ||
| | |005 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|merc:}}initiator>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
| | |006 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}} | ||
|[[ListOptions|bs:ListOptions]] | |[[ListOptions|bs:ListOptions]] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Параметры запрашиваемого списка. | |||
|style=" | |||
|- | |- | ||
| | |007 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | ||
|[0..1] | |[0..1] | ||
|Максимальное запрашиваемое количество объектов в списке. | |<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | ||
<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке.</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* По умолчанию значение 100; | * По умолчанию значение 100; | ||
* Максимально возможное значение 1000. | * Максимально возможное значение 1000.</div> | ||
</div> | |||
|- | |- | ||
| | |008 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | ||
|[0..1] | |[0..1] | ||
|Номер элемента, по которому осуществляется смещение первого элемента списка. | |<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | ||
<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка. </span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* По умолчанию значение 0.</div> | |||
</div> | |||
|- | |- | ||
| | |009 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
| | |010 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}getBusinessEntityUserListRequest>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
|} | |} |
Версия 05:13, 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] | Максимальное запрашиваемое количество объектов в списке.
|
008 | ······<bs:offset>2</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
009 | ···</bs:listOptions> | |||
010 | </merc:getBusinessEntityUserListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <merc:getBusinessEntityUserListResponse> | ||||
2 | ···<vd:userList> | vd:UserList | [1..1] | Список пользователей | |
3 | ······<vd:user> | vd:User | [0..*] | Описание пользователя системы | |
4 | ·········<bs:uuid> | bs:UUID | [1..1] | Уникальный идентификатор пользователя | <bs:uuid>138712f8-823a-4184-b58e-863cc2af18cf</bs:uuid> |
5 | ·········<vd:login> | xs:NCName | [1..1] | Логин пользователя | <vd:login>ivanov_ii_171105</vd:login> |
6 | ·········<vd:firstName> | bs:String255 | [0..1] | Имя | <vd:firstName>Иванов</vd:firstName> |
7 | ·········<vd:middleName> | bs:String255 | [0..1] | Отчество | <vd:middleName>Иван</vd:middleName> |
8 | ·········<vd:lastName> | bs:String255 | [0..1] | Фамилия | <vd:lastName>Иванович</vd:lastName> |
9 | ·········<vd:birthDate> | xs:DateTime | [0..1] | Дата рождения | <vd:birthDate>1987-01-02T00:00:00.000+03:00</vd:birthDate> |
10 | ·········<vd:phone> | bs:String255 | [0..1] | Телефон пользователя | <vd:phone>23-23-23</vd:phone> |
11 | ·········<vd:workPhone> | bs:String255 | [0..1] | Рабочий телефон пользователя | <vd:workPhone>23-23-25</vd:workPhone> |
12 | ·········<vd:email> | bs:String255 | [0..1] | Адрес электронной почты пользователя | <vd:email>1511440241708@yandex.ru</vd:email> |
13 | ·········<vd:workEmail> | bs:String255 | [0..1] | Рабочий адрес электронной почты пользователя | <vd:workEmail>34833784001f@yandex.ru</vd:workEmail> |
14 | ·········<vd:post> | bs:String255 | [0..1] | Должность пользователя | <vd:post>Должность</vd:post> |
15 | ·········<vd:authorityList> | vd:AuthorityList | [0..1] | Список ролей пользователя | |
16 | ············<vd:authority> | vd:UserAuthority | [1..*] | Роль пользователя | |
17 | ···············<vd:ID> | xs:NCName | [1..1] | Идентификатор роли пользователя | <vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> |
18 | ···············<vd:name> | bs:String255 | [1..1] | Описание роли пользователя | <vd:name>Авторизованный заявитель в системе Меркурий</vd:name> |
19 | ············</vd:authority> | ||||
20 | ·········</vd:authorityList> | ||||
21 | ······</vd:user> | ||||
22 | ···</vd:userList> | ||||
23 | </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>