GetApplicableUserAuthorityList v2: различия между версиями
Перейти к навигации
Перейти к поиску
м (Nikeshina-ad-171025 переименовал страницу GetApplicableUserAuthorityList v2.0 в GetApplicableUserAuthorityList v2) |
|||
(не показано 5 промежуточных версий 2 участников) | |||
Строка 23: | Строка 23: | ||
** [[AuthorityList_v2.0|vd:AuthorityList]] | ** [[AuthorityList_v2.0|vd:AuthorityList]] | ||
** [[UserAuthority_v2.0|vd:UserAuthority]] | ** [[UserAuthority_v2.0|vd:UserAuthority]] | ||
{{столбец}} | {{столбец}} | ||
Строка 44: | Строка 43: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}getApplicableUserAuthorityListRequest>'''}} | ||
| | | | ||
| | | | ||
| 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="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |010 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}getApplicableUserAuthorityListRequest>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
|} | |} | ||
Строка 129: | Строка 127: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}getApplicableUserAuthorityListResponse>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |002 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}authorityList {{color|Red|total=}}{{color|#007f15|"10"}} {{color|Red|offset=}}{{color|#007f15|"0"}} {{color|Red|count=}}{{color|#007f15|"10"}}>'''}} | ||
|[[AuthorityList_v2.0|vd:AuthorityList]] | |[[AuthorityList_v2.0|vd:AuthorityList]] | ||
|[1..1] | |[1..1] | ||
| style="width:52em;"| Список ролей пользователя | |||
|style=" | |||
|- | |- | ||
| | |003 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}authority>'''}} | ||
|[[UserAuthority_v2.0|vd:UserAuthority]] | |[[UserAuthority_v2.0|vd:UserAuthority]] | ||
|[0..*] | |[0..*] | ||
| style="width:52em;"| Роль пользователя | |||
|style=" | |||
|- | |- | ||
| | |004 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |005 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |006 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}authority>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |007 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}authorityList>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |008 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}getApplicableUserAuthorityListResponse>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
|} | |} | ||
Строка 217: | Строка 206: | ||
</merc:initiator> | </merc:initiator> | ||
<bs:listOptions> | <bs:listOptions> | ||
<bs:count> | <bs:count>100</bs:count> | ||
<bs:offset>0</bs:offset> | <bs:offset>0</bs:offset> | ||
</bs:listOptions> | </bs:listOptions> | ||
Строка 322: | Строка 311: | ||
</div> | </div> | ||
<br/> | <br/> | ||
[[Category:Ветис.API]] |
Текущая версия на 12:08, 1 июня 2023
Общие сведения
Операция GetApplicableUserAuthorityList предназначена для получения списка прав пользователей для системы Меркурий.
При выполнении операции на вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- параметры запрашиваемого списка.
Результатом выполнения данной операции является:
- список прав пользователей.
Возможные сценарии
1. Получение списка прав пользователей
- 1.1. Запрос успешно обработан.
- 1.2. Произошла ошибка выполнения запроса:
- Некорректный запрос.
- Внутренняя ошибка системы.
Используемые пространства имен и типы
|
|
|
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:getApplicableUserAuthorityListRequest> | |||
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:getApplicableUserAuthorityListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:getApplicableUserAuthorityListResponse> | |||
002 | ···<vd:authorityList total="10" offset="0" count="10"> | vd:AuthorityList | [1..1] | Список ролей пользователя |
003 | ······<vd:authority> | vd:UserAuthority | [0..*] | Роль пользователя |
004 | ·········<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> | xs:NCName | [1..1] | Идентификатор роли пользователя |
005 | ·········<vd:name>Авторизованный заявитель в системе Меркурий</vd:name> | bs:String255 | [1..1] | Описание роли пользователя |
006 | ······</vd:authority> | |||
007 | ···</vd:authorityList> | |||
008 | </merc:getApplicableUserAuthorityListResponse> |
Примеры запросов
Запрос списка прав
Запрос списка прав
<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:getApplicableUserAuthorityListRequest>
<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:getApplicableUserAuthorityListRequest>
</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:getApplicableUserAuthorityListResponse>
<vd:authorityList>
<vd:authority>
<vd:ID>MERCURY_ACCESS_WEB_READ</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:authority>
<vd:ID>ARGUS_HS_AUTHORIZED_APPLICANT</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_CONTROL_WORKING_AREA</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_CERTIFICATE_ACCEPTANCE</vd:ID>
<vd:name>Гашение ВСД</vd:name>
</vd:authority>
<vd:authority>
<vd:ID>MERCURY_AUTHORIZED_CERTIFICATE_ACCEPTANCE</vd:ID>
<vd:name>Уполномоченное гашение ВСД</vd:name>
</vd:authority>
<vd:authority>
<vd:ID>MERCURY_AUTHORIZED_RETURNED_CERTIFICATE_CREATION</vd:ID>
<vd:name>Уполномоченное оформление возвратных ВСД</vd:name>
</vd:authority>
<vd:authority>
<vd:ID>MERCURY_HS_FISH_CERTIFICATE</vd:ID>
<vd:name>Сертификация уловов ВБР</vd:name>
</vd:authority>
<vd:authority>
<vd:ID>MERCURY_PRODUCTION_BATCH_CERTIFICATE</vd:ID>
<vd:name>Оформление ВСД на производственную партию</vd:name>
</vd:authority>
<vd:authority>
<vd:ID>MERCURY_HS_FRESH_MILK_CERTIFICATE</vd:ID>
<vd:name>Оформление ВСД на сырое молоко (при наличии справки о безопасности сырого молока)</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_RETURNED_CERTIFICATE_CREATION</vd:ID>
<vd:name>Оформление возвратных ВСД</vd:name>
</vd:authority>
</vd:authorityList>
</merc:getApplicableUserAuthorityListResponse>
</apl:result>
</apl:application>
</apldef:receiveApplicationResultResponse>
</env:Body>
</env:Envelope>