GetBusinessEntityUser v2: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 130: | Строка 130: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}getBusinessEntityUserResponse>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |002 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}} | ||
|[[User_v2.0|vd:User]] | |[[User_v2.0|vd:User]] | ||
|[1..1] | |[1..1] | ||
| style="width:52em;"| Описание пользователя системы | |||
|style=" | |||
|- | |- | ||
| | |003 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |004 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |005 | ||
|style="font-weight: | |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]] | ||
|[ | |[1..1] | ||
| style="width:52em;"| Имя | |||
|style=" | |||
|- | |- | ||
| | |006 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |007 | ||
|style="font-weight: | |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]] | ||
|[ | |[1..1] | ||
| style="width:52em;"| Фамилия | |||
|style=" | |||
|- | |- | ||
| | |008 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}workPhone>'''}}{{color|#131313|23-23-25}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}workPhone>'''}} | ||
| | |||
| | |||
| | |||
| | |||
| | |||
|[[String255|bs:String255]] | |[[String255|bs:String255]] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Рабочий телефон пользователя | |||
|style=" | |||
|- | |- | ||
| | |009 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |010 | ||
|style="font-weight: | |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=" | |||
|- | |- | ||
| | |011 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}authorityList>'''}} | ||
| | |||
| | |||
| | |||
|[[AuthorityList_v2.0|vd:AuthorityList]] | |[[AuthorityList_v2.0|vd:AuthorityList]] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Список ролей пользователя | |||
|style=" | |||
|- | |- | ||
| | |012 | ||
|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]] | ||
|[1..*] | |[1..*] | ||
| style="width:52em;"| Роль пользователя | |||
|style=" | |||
|- | |- | ||
| | |013 | ||
|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=" | |||
|- | |- | ||
| | |014 | ||
|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=" | |||
|- | |- | ||
| | |015 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}authority>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
| | |016 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}authorityList>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
| | |017 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
| | |018 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}getBusinessEntityUserResponse>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
|} | |} |
Версия 05:12, 2 марта 2018
Общие сведения
Операция GetBusinessEntityUser предназначена для получения данных пользователя по логину или его уникальному идентификатору.
При выполнении операции на вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- имя пользователя или уникальный идентификатор, если существующий пользователь привязывается к ХС.
Результатом выполнения данной операции является:
- возврат данных по запрошенному пользователю.
Возможные сценарии
1. Получение данных пользователя
- 1.1. Запрос успешно обработан.
- 1.2. Произошла ошибка выполнения запроса:
- Запрашиваемый пользователь отсутствует в системе.
- Некорректный запрос.
- Внутренняя ошибка системы.
Инициатор запроса Инициатор запроса должен иметь связь с хозяйствующем субъектом. Для выполнения операций по получению данных пользователей инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".
|
Используемые пространства имен и типы
|
|
|
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:getBusinessEntityUserRequest> | |||
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..1] | Описание пользователя системы
|
007 | ······<bs:uuid>UUID</bs:uuid> | bs:UUID | [0..1] | Уникальный идентификатор пользователя |
008 | ······<vd:login>ivanov_ii_171105</vd:login> | xs:NCName | [0..1] | Логин пользователя |
009 | ···</vd:user> | |||
010 | </merc:getBusinessEntityUserRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:getBusinessEntityUserResponse> | |||
002 | ···<vd:user> | vd:User | [1..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:getBusinessEntityUserResponse> |
Примеры запросов
Запрос пользователя по login
Запрос пользователя по login
<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:getBusinessEntityUserRequest>
<merc:localTransactionId>a10003</merc:localTransactionId>
<merc:initiator>
<vd:login>login</vd:login>
</merc:initiator>
<vd:user>
<vd:login>ivanov_ii_171108</vd:login>
</vd:user>
</merc:getBusinessEntityUserRequest>
</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:user>
<bs:uuid>16676f0a-faf7-4025-909b-01f91de64ad3</bs:uuid>
<vd:login>ivanov_ii_171108</vd:login>
<vd:authorityList>
<vd:authority>
<vd:ID>MERCURY_PRODUCTION_BATCH_CERTIFICATE</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_RETURNED_CERTIFICATE_CREATION</vd:ID>
<vd:name>Оформление возвратных ВСД</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_WEB_READ</vd:ID>
<vd:name>Доступ к веб-интерфейсу ИС Меркурий только на чтение</vd:name>
</vd:authority>
<vd:authority>
<vd:ID>MERCURY_CERTIFICATE_ACCEPTANCE</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_HS_AUTHORIZED_APPLICANT</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:authorityList>
<vd:authorityList>
<vd:authority>
<vd:ID>ARGUS_HS_AUTHORIZED_APPLICANT</vd:ID>
<vd:name>Авторизованный заявитель в системе Аргус</vd:name>
</vd:authority>
</vd:authorityList>
</vd:user>
</merc:getBusinessEntityUserResponse>
</apl:result>
</apl:application>
</apldef:receiveApplicationResultResponse>
</env:Body>
</env:Envelope>