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

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


==Данные запроса==
==Данные запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Кардинальность
! Описание
! Пример
|-
| 1
| style="font-weight: bold; font-family: Courier;" | <merc:withdrawVetDocumentRequest>
|
|
|
|
|-
| 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:vetDocumentId>
| [[UUID|bs:UUID]]
| [1..1]
| Идентификатор ВСД, который аннулируется.
| <bs:uuid>9b7082e2-2d20-4182-be1a-c93974f8b8c6</bs:uuid>
|-
| 7
| style="font-weight: bold; font-family: Courier;" | ···&lt;dt:withdrawReason>
| [[VetDocumentStatusChangeReason_v2.0|vd:VetDocumentStatusChangeReason]]
| [1..1]
| Причина аннулирования ВСД.
| &lt;dt:withdrawReason>Неверно указан объём продукции</dt:withdrawReason>
|-
| 8
| style="font-weight: bold; font-family: Courier;" | ···<vd:withdrawDate>
| [http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
| [1..1]
| Дата события.
| <vd:withdrawDate>2017-07-07T12:00:00</vd:withdrawDate>
|-
| 9
| style="font-weight: bold; font-family: Courier;" | ···<merc:specifiedPerson>
| [[User_v2.0|dt:User]]
| [1..1]
| Ветеринарный врач, ответственный за аннулирование сертификата.
|
|-
| 10
| style="font-weight: bold; font-family: Courier;" | ······&lt;dt:login>
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
| [0..1]
| Логин пользователя, зарегистрированного в системе Меркурий.
| &lt;dt:login>user-ab-150101</dt:login>
|-
| 11
| style="font-weight: bold; font-family: Courier;" | ···</merc:specifiedPerson>
|
|
|
|
|-
| 12
| style="font-weight: bold; font-family: Courier;" | </merc:withdrawVetDocumentRequest>
|
|
|
|
|}


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

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

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

Операция WithdrawVetDocumentOperation предназначена для аннулирования ветеринарных сопроводительных документов (ВСД). Если ВСД содержит ошибки, либо фактические сведения отличаются от того, что указано в ВСД, то такой документ может быть аннулирован. После аннулирования ВСД становится недействительным. Операция аннулирования через шлюз Ветис.API доступна только для транспортных сертификатов. Производственные сертификаты необходимо аннулировать через веб-интерфейс путем аннулирования запись журнала вырабатываемой продукции или производственной транзакции.

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

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

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

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

  • ВСД переходит в статус "Аннулирован";
  • В журнал продукции предприятие-отправителя возвращается объем продукции, на которую был выдан аннулированный ВСД.

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

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

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

# Название XML-элемента Тип Кардинальность Описание Пример
1 <merc:withdrawVetDocumentRequest>
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:vetDocumentId> bs:UUID [1..1] Идентификатор ВСД, который аннулируется. <bs:uuid>9b7082e2-2d20-4182-be1a-c93974f8b8c6</bs:uuid>
7 ···<dt:withdrawReason> vd:VetDocumentStatusChangeReason [1..1] Причина аннулирования ВСД. <dt:withdrawReason>Неверно указан объём продукции</dt:withdrawReason>
8 ···<vd:withdrawDate> xs:DateTime [1..1] Дата события. <vd:withdrawDate>2017-07-07T12:00:00</vd:withdrawDate>
9 ···<merc:specifiedPerson> dt:User [1..1] Ветеринарный врач, ответственный за аннулирование сертификата.
10 ······<dt:login> xs:NCName [0..1] Логин пользователя, зарегистрированного в системе Меркурий. <dt:login>user-ab-150101</dt:login>
11 ···</merc:specifiedPerson>
12 </merc:withdrawVetDocumentRequest>

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

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


Коды ошибок

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

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