UnbindBusinessEntityUser v2: различия между версиями
Перейти к навигации
Перейти к поиску
м (Nikeshina-ad-171025 переименовал страницу UnbindBusinessEntityUser v2.0 в UnbindBusinessEntityUser v2) |
|||
(не показано 8 промежуточных версий 2 участников) | |||
Строка 24: | Строка 24: | ||
|type = notice | |type = notice | ||
|text = '''Инициатор запроса''' | |text = '''Инициатор запроса''' | ||
|text-small = Инициатор запроса должен иметь связь с хозяйствующем субъектом | |text-small = Инициатор запроса должен иметь связь с хозяйствующем субъектом. Для выполнения операций по удалению связи пользователей с хозяйствующим субъектом инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт". | ||
}} | }} | ||
{{ambox | {{ambox | ||
Строка 57: | Строка 57: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}unbindBusinessEntityUserRequest>'''}} | ||
| | | | ||
| | | | ||
| 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|vd:}}user>'''}} | ||
|[[User_v2.0|vd:User]] | |[[User_v2.0|vd:User]] | ||
|[1..*] | |[1..*] | ||
|Описание пользователя системы | |<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | ||
* Обязательно указывать или uuid или login пользователя | <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: | |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]] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Уникальный идентификатор пользователя | |||
|style=" | |||
|- | |- | ||
| | |008 | ||
|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] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Логин пользователя | |||
|style=" | |||
|- | |- | ||
| | |009 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |010 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}unbindBusinessEntityUserRequest>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
|} | |} | ||
Строка 140: | Строка 136: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<{{color|#660e7a|merc:}}addBusinessEntityUserResponse>'''}} | ||
| | | | ||
| | | | ||
| 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..*] | ||
| 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=" | |||
|- | |- | ||
| | |014 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}} | ||
| | |||
| | |||
| | |||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |015 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|merc:}}addBusinessEntityUserResponse>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
|} | |} | ||
Строка 333: | Строка 295: | ||
</div> | </div> | ||
<br/> | <br/> | ||
[[Category:Ветис.API]] | |||
Текущая версия на 12:08, 1 июня 2023
Общие сведения
Операция UnbindBusinessEntityUser предназначена для удаления связи между пользователем и хозяйствующим субъектом.
При выполнении операции на вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- имя пользователя или его уникальный идентификатор.
Результатом выполнения данной операции является:
- удаление связи между пользователем и хозяйствующим субъектом.
Возможные сценарии
1. Удаление связи между пользователем и хозяйствующим субъектом.
2. Если пользователь не связан с ХС-заявителем, то отказ в выполнении операции.
3. Некорректный запрос.
4. Внутренняя ошибка системы.
Инициатор запроса Инициатор запроса должен иметь связь с хозяйствующем субъектом. Для выполнения операций по удалению связи пользователей с хозяйствующим субъектом инициатор запроса должен иметь роль "Администратор ХС" в системе "Ветис.Паспорт".
|
Удаление связи для списка пользователей Операция поддерживает удаление связи с хозяйствующим субъектом списка пользователей в рамках одного запроса.
|
Используемые пространства имен и типы
|
|
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:unbindBusinessEntityUserRequest> | |||
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..*] | Описание пользователя системы
|
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:unbindBusinessEntityUserRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:addBusinessEntityUserResponse> | |||
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] | Должность пользователя |
014 | ···</vd:user> | |||
015 | </merc:addBusinessEntityUserResponse> |
Примеры запросов
Удаление связи пользователя с хозяйствующим субъектом
Удаление связи пользователя с хозяйствующим субъектом
<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:unbindBusinessEntityUserRequest>
<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:unbindBusinessEntityUserRequest>
</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:unbindBusinessEntityUserResponse>
<vd:user>
<bs:uuid>a2121ff5-aa6d-4de7-b144-3f2cbd52a8ad</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>1511338333788@yandex.ru</vd:email>
<vd:workEmail>1511338333788@yandex.ru</vd:workEmail>
</vd:user>
</merc:unbindBusinessEntityUserResponse>
</apl:result>
</apl:application>
</apldef:receiveApplicationResultResponse>
</env:Body>
</env:Envelope>