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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 17: Строка 17:


== Данные запроса ==
== Данные запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Кардинальность
! Описание
! Пример
|-
| 1
| style="font-weight: bold; font-family: Courier;" | <merc:getVetDocumentByUuidRequest>
|
|
|
|
|-
| 2
| style="font-weight: bold; font-family: Courier;" | ···<merc:localTransactionId>
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
| [1..1]
| Идентификатор заявки в клиентской системе.
| <bs:guid>A00001</bs:guid>
|-
| 3
| style="font-weight: bold; font-family: Courier;" | ···<merc:initiator>
| [[User_v2.0|dt:User]]
| [1..1]
| Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
|
|-
| 4
| style="font-weight: bold; font-family: Courier;" | ······&lt;dt:login>
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
| [1..1]
| Логин пользователя, зарегистрированного в системе Меркурий.
| &lt;dt:login>user_ab_150101</dt:login>
|-
| 5
| style="font-weight: bold; font-family: Courier;" | ···</merc:initiator>
|
|
|
|
|-
| 6
| style="font-weight: bold; font-family: Courier;" | ···<bs:uuid>
| [[UUID|bs:UUID]]
| [1..1]
| Идентификатор ВСД.
| <bs:uuid>9b7082e2-2d20-4182-be1a-c93974f8b8c6</bs:uuid>
|-
| 7
| style="font-weight: bold; font-family: Courier;" | ···&lt;dt:enterpriseGuid>
| [[enterpriseGuid_v2.0|dt:enterpriseGuid]]
| [1..1]
| Идентификатор предприятия, по которому производится поиск документа.
| &lt;dt:enterpriseGuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</dt:enterpriseGuid>
|-
| 8
| style="font-weight: bold; font-family: Courier;" | </merc:getVetDocumentByUuidRequest>
|
|
|
|
|}


==Данные ответа==
==Данные ответа==

Версия 19:22, 16 июля 2017

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

Операция GetVetDocumentByUuidOperation предназначена для получения ветеринарного сопроводительного документа (ВСД) по его уникальному идентификатору.

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

  • информация о пользователе - инициаторе запроса;
  • идентификатор ВСД.

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

  • сведения о запрашиваемом ВСД.

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

При обработке запроса возможны следующие сценарии:

1.1. Запрос успешно обработан. Пользователю вернулся запрашиваемый ВСД.
1.2. Произошла ошибка при обработке запроса.
• Некорректный запрос.
• Внутренняя ошибка системы.

Данные запроса

# Название XML-элемента Тип Кардинальность Описание Пример
1 <merc:getVetDocumentByUuidRequest>
2 ···<merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе. <bs:guid>A00001</bs:guid>
3 ···<merc:initiator> dt:User [1..1] Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
4 ······<dt:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий. <dt:login>user_ab_150101</dt:login>
5 ···</merc:initiator>
6 ···<bs:uuid> bs:UUID [1..1] Идентификатор ВСД. <bs:uuid>9b7082e2-2d20-4182-be1a-c93974f8b8c6</bs:uuid>
7 ···<dt:enterpriseGuid> dt:enterpriseGuid [1..1] Идентификатор предприятия, по которому производится поиск документа. <dt:enterpriseGuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</dt:enterpriseGuid>
8 </merc:getVetDocumentByUuidRequest>

Данные ответа

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

Получение ВСД по идентификатору

<codeblock language="xml" class="mw-collapsible>

</syntaxhighlight>

Коды ошибок

Вернуться к началу ↑