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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 220: Строка 220:
! Тип
! Тип
! Обязат.
! Обязат.
! Описание
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
|-
|-
|1
|001
|style="font-weight: bold; font-family: Courier;" |<merc:updateUserAuthoritiesResponse>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}updateUserAuthoritiesResponse>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|2
|002
|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]]
|[1..*]
|[1..*]
|Описание пользователя системы
| style="width:52em;"| Описание пользователя системы
|style="font-family: Courier;" |
|-
|-
|3
|003
|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>
|-
|-
|4
|004
|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>
|-
|-
|5
|005
|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>
|-
|-
|6
|006
|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>
|-
|-
|7
|007
|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>
|-
|-
|8
|008
|style="font-weight: bold; font-family: Courier;" |······<vd:birthDate>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}workPhone>'''}}{{color|#131313|23-23-25}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}workPhone>'''}}
|[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>
|-
|9
|style="font-weight: bold; font-family: Courier;" |······<vd:phone>
|[[String255|bs:String255]]
|[[String255|bs:String255]]
|[0..1]
|[0..1]
|Телефон пользователя
| style="width:52em;"| Рабочий телефон пользователя
|style="font-family: Courier;" |<vd:phone>23-23-23</vd:phone>
|-
|-
|10
|009
|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>
|-
|-
|11
|010
|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>
|-
|-
|12
|011
|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>
|-
|13
|style="font-weight: bold; font-family: Courier;" |······<vd:post>
|[[String255|bs:String255]]
|[0..1]
|Должность пользователя
|style="font-family: Courier;" |<vd:post>Должность</vd:post>
|-
|14
|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;" |
|-
|-
|15
|012
|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;" |
|-
|-
|16
|013
|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>
|-
|-
|17
|014
|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>
|-
|-
|18
|015
|style="font-weight: bold; font-family: Courier;" |·········</vd:authority>
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}authority>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|19
|016
|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;"|  
|-
|-
|20
|017
|style="font-weight: bold; font-family: Courier;" |···</vd:user>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|21
|018
|style="font-weight: bold; font-family: Courier;" |</merc:updateUserAuthoritiesResponse>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}updateUserAuthoritiesResponse>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|}
|}

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

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

Операция UpdateUserAuthorities предназначена для назначения или изменения прав доступа пользователей в системе Меркурий. Роли пользователя изменяются только применительно к хозяйствующему субъекту, инициировавшему запрос на выполнение данной операции.

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

  • информация о пользователе - инициаторе запроса;
  • имя пользователя или его уникальный идентификатор;
  • список прав доступа (ролей), которые необходимо назначить пользователю.

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

  • назначение пользователю указанных в запросе прав.


Обратите внимание
 ОБРАТИТЕ ВНИМАНИЕ:
Список прав пользователя перезаписывается с каждым запросом. Поэтому при назначении прав следует всегда передавать полный список необходимых ролей. Если у пользователя была роль, которая не была передана с новым запросом, то она станет не активна.


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

1. Назначение списка прав.

  • Назначение указанных в запросе прав пользователю в системе "Ветис.Паспорт".
  • Если пользователь не связан с ХС-заявителем, то отказ в выполнении операции.
  • Некорректный запрос.
  • Внутренняя ошибка системы.

Список доступных для назначения ролей

На данный момент доступен для назначения следующий список прав:

ID роли Наименование роли
MERCURY_ACCESS_WEB_READ Доступ к веб-интерфейсу ИС Меркурий только на чтение
MERCURY_ACCESS_WEB_WRITE Доступ к веб-интерфейсу ИС Меркурий на выполнение операций
ARGUS_HS_AUTHORIZED_APPLICANT Авторизованный заявитель в системе Аргус
MERCURY_ACCESS_API_READ Доступ к ИС Меркурий через Ветис.API только на чтение
MERCURY_CONTROL_WORKING_AREA Управление зонами ответственности пользователей
MERCURY_ACCESS_API_WRITE Доступ к ИС Меркурий через Ветис.API на выполнение операций
MERCURY_CERTIFICATE_ACCEPTANCE Гашение ВСД
MERCURY_AUTHORIZED_CERTIFICATE_ACCEPTANCE Уполномоченное гашение ВСД
MERCURY_AUTHORIZED_RETURNED_CERTIFICATE_CREATION Уполномоченное оформление возвратных ВСД
MERCURY_HS_FISH_CERTIFICATE Сертификация уловов ВБР
MERCURY_PRODUCTION_BATCH_CERTIFICATE Оформление ВСД на производственную партию
MERCURY_HS_FRESH_MILK_CERTIFICATE Оформление ВСД на сырое молоко (при наличии справки о безопасности сырого молока)
MERCURY_HS_AUTHORIZED_APPLICANT Авторизованный заявитель в системе Меркурий
MERCURY_RETURNED_CERTIFICATE_CREATION Оформление возвратных ВСД

Список доступных ролей также можно получить с помощью операции - getApplicableUserAuthorityList.


Информация
 Инициатор запроса
Инициатор запроса должен иметь связь с хозяйствующем субъектом. Для выполнения операций по управлению правами пользователей инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".


Информация
 Назначение прав списку пользователей
Операция поддерживает назначение прав списку пользователей в рамках одного запроса.


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



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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:updateUserAuthoritiesRequest>
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 ···<vd:user> vd:User [1..*]

Описание пользователя системы

  • Обязательно указывать или uuid или login пользователя
007 ······<bs:uuid>UUID</bs:uuid> bs:UUID [0..1] Уникальный идентификатор пользователя
008 ······<vd:login>ivanov_ii_171105</vd:login> xs:NCName [0..1] Логин пользователя
009 ······<vd:authorityList> vd:AuthorityList [1..1] Список ролей пользователя
010 ·········<vd:authority> vd:UserAuthority [1..*] Роль пользователя
011 ············<vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID> xs:NCName [1..1] Идентификатор роли пользователя
012 ·········</vd:authority>
013 ······</vd:authorityList>
014 ···</vd:user>
015 </merc:updateUserAuthoritiesRequest>

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

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

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

Назначение списка ролей пользователю

Назначение списка ролей пользователю 

<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:UpdateUserAuthoritiesRequest>
            <merc:localTransactionId>a10003</merc:localTransactionId>
            <merc:initiator>
              <vd:login>login</vd:login>
            </merc:initiator>
	     <vd:user>
              <vd:login>ivanov_ii_171108</vd:login>
              <vd:authorityList>
                <vd:authority>
                  <vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_WEB_READ</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_WEB_WRITE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_API_READ</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_API_WRITE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_CONTROL_WORKING_AREA</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_PRODUCTION_BATCH_CERTIFICATE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_CERTIFICATE_ACCEPTANCE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_RETURNED_CERTIFICATE_CREATION</vd:ID>
                </vd:authority>
              </vd:authorityList>
            </vd:user>
          </merc:UpdateUserAuthoritiesRequest>
        </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:UpdateUserAuthoritiesResponse>
            <vd:user>
              <bs:uuid>80b3835a-5669-4f28-b383-ab11bc0a6cc1</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>1512053061952@yandex.ru</vd:email>
              <vd:workEmail>1512053061952@yandex.ru</vd:workEmail>
	       <vd:authorityList>
                <vd:authority>
                  <vd:ID>MERCURY_AUTHORIZED_APPLICANT</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_WEB_READ</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_WEB_WRITE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_API_READ</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_ACCESS_API_WRITE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_CONTROL_WORKING_AREA</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_PRODUCTION_BATCH_CERTIFICATE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_CERTIFICATE_ACCEPTANCE</vd:ID>
                </vd:authority>
                <vd:authority>
                  <vd:ID>MERCURY_RETURNED_CERTIFICATE_CREATION</vd:ID>
                </vd:authority>
              </vd:authorityList>
            </vd:user>
          </merc:UpdateUserAuthoritiesResponse>
        </apl:result>
      </apl:application>
    </apldef:receiveApplicationResultResponse>
  </env:Body>
</env:Envelope>



Источник — http://help.vetrf.ru/index.php?title=UpdateUserAuthorities_v2&oldid=23077