MercuryG2B:GetBusinessEntityUserList:v3.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «== Спецификация ответа == {| class="wikitable" ! # ! Название XML-элемента ! Тип ! Обязат. ! Описание (наж...»)
 
 
(не показано 11 промежуточных версий этого же участника)
Строка 1: Строка 1:
== Общие сведения ==
{| class="wikitable"
! Код операции !! Описание операции
|-
| '''...'''
| Получение списка пользователей хозяйствующего субъекта
|-
|}
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}getBusinessEntityUserListRequest>'''}}
|
|
|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|merc:}}localTransactionId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|merc:}}localTransactionId>'''}}
|xs:NCName
|[1..1]
| style="width:52em;"| Идентификатор заявки в клиентской системе
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|merc:}}initiator>'''}}
|vd:User
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|xs:NCName
|[1..1]
|style="width:52em;"| Логин пользователя, зарегистрированного в системе Меркурий
|-
|005
| style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|merc:}}initiator>'''}}
|
|
|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|bs:ListOptions
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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;">
* Обязательно указывать или uuid или login пользователя
</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
|xs:nonNegativeInteger
|[0..1]
|style="width:52em;"> | Максимальное запрашиваемое количество объектов в списке
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
|xs:nonNegativeInteger
|[0..1]
|style="width:52em;"| Номер элемента, по которому осуществляется смещение первого элемента списка
|-
|-
|009
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
|
|-
|010
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}getBusinessEntityUserListRequest>'''}}
|
|
|
|}
== Спецификация ответа ==
== Спецификация ответа ==


Строка 15: Строка 107:
|-
|-
|002
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}userList{{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}userList {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|vd:UserList
|vd:UserList
|[1..1]
|[1..1]
|style="width:52em;"| Описание пользователя системы
|style="width:52em;"| Список пользователей
|-
|-
|003
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}}
|vd:User
|vd:User
|[1..*]
|[0..*]
|style="width:52em;"| Описание пользователя системы
|style="width:52em;"| Описание пользователя системы


Строка 92: Строка 184:
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|vd:}}ID>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}ID>'''}}
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|vd:}}ID>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}ID>'''}}
|xs:NCName
|xs:NCName
|[0..1]
|[1..1]
|style="width:52em;"| Идентификатор роли пользователя
|style="width:52em;"| Идентификатор роли пользователя
|-
|-
Строка 131: Строка 223:
| style="width:52em;"|  
| style="width:52em;"|  
|}
|}
== Примеры запросов ==
'''TODO'''
== См. также ==
[[#top|Вернуться к началу &uarr;]]</br>
[[MercuryG2B:Services:v3.0|Вернуться на страницу профиля API MercuryG2B:Services:v3.0]]
[[Category:MercuryG2B]]
[[Category:MercuryG2B:GetBusinessEntityUserList]]

Текущая версия на 13:30, 17 июня 2024

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:getBusinessEntityUserListRequest>
002 ···<merc:localTransactionId>?</merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе
003 ···<merc:initiator> vd:User [1..1]

Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу

  • Является ответственным за выполнение бизнес-операции
  • Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий
005 ···</merc:initiator>
006 ···<bs:listOptions> bs:ListOptions [0..1]

Параметры запрашиваемого списка

  • Обязательно указывать или uuid или login пользователя
007 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке
008 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка
009 ···</bs:listOptions>
010 </merc:getBusinessEntityUserListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:getBusinessEntityUserListResponse>
002 ···<dt:userList total="?" offset="?" count="?"> vd:UserList [1..1] Список пользователей
003 ······<vd:user> vd:User [0..*] Описание пользователя системы
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор пользователя
005 ·········<vd:login>?</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>?</vd:workPhone> bs:String255 [0..1] Рабочий телефон пользователя
010 ·········<vd:workEmail>?</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>?</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>

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0

Источник — http://help.vetrf.ru/index.php?title=MercuryG2B:GetBusinessEntityUserList:v3.0&oldid=40414