GetApplicableUserAuthorityList v2: различия между версиями

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

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

Операция GetApplicableUserAuthorityList предназначена для получения списка прав пользователей для системы Меркурий.

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

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

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

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

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

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

1.1. Запрос успешно обработан.

1.2. Произошла ошибка выполнения запроса:

Некорректный запрос.
Внутренняя ошибка системы.

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

vd (http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2)
- vd:AuthorityList
- vd:UserAuthority

bs (http://api.vetrf.ru/schema/cdm/base)
- bs:String255
- bs:UUID

xs (http://www.w3.org/2001/XMLSchema)

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

#	Название XML-элемента	Тип	Обязат.	Описание	Пример
1	<merc:getApplicableUserAuthorityListRequest>
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>
10	</merc:getApplicableUserAuthorityListRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание	Пример
1	<merc:getApplicableUserAuthorityListResponse>
2	···<vd:authorityList>	vd:AuthorityList	[1..1]	Список ролей пользователя
3	······<vd:authority>	vd:UserAuthority	[0..*]	Роль пользователя
4	·········<vd:ID>	xs:NCName	[1..1]	Идентификатор роли пользователя	<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID>
5	·········<vd:name>	bs:String255	[1..1]	Описание роли пользователя	<vd:name>Авторизованный заявитель в системе Меркурий</vd:name>
6	······</vd:authority>
7	···</vd:authorityList>
8	</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>

@@ Строка 23: / Строка 23: @@
 ** [[AuthorityList_v2.0|vd:AuthorityList]]
 ** [[UserAuthority_v2.0|vd:UserAuthority]]
-** [[User_v2.0|vd:User]]
 {{столбец}}