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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Egorova-iv-150707 переименовал страницу WithdrawVetDocumentOperation в WithdrawVetDocumentOperation v1.2)
 
 
(не показано 9 промежуточных версий 3 участников)
Строка 1: Строка 1:
#перенаправление [[WithdrawVetDocumentOperation v1.2]]
==Общие сведения==
Операция '''WithdrawVetDocumentOperation''' предназначена для аннулирования ветеринарно-сопроводительных документов (ВСД). Если ВСД содержит ошибки, либо фактические сведения отличаются от того, что указано в ВСД, то такой документ может быть аннулирован, то есть такой документ становится недействительным. Операция аннулирования через шлюз Ветис.API доступна ТОЛЬКО для транспортных сертификатов. Производственные сертификаты нужно аннулировать через веб-интерфейс через запись журнала или транзакцию.
 
После того как ВСД был аннулирован, объем продукции, на которую был выдан данный ВСД, возвращается в журнал предприятия-отправителя и взамен аннулированного врач может выдать новый ВСД на эту партию продукции, содержащий верные сведения.
Аннулировать ВСД может тот, кто его выписал, либо другой ветеринарный врач обслуживающий то предприятие, с которого данный ВСД был выписан.
Если ВСД был погашен, то его аннулировать уже нельзя, то есть для аннулирования ВСД должен быть в статусе '''"Оформлен"'''.
 
При выполнении операции '''WithdrawVetDocumentOperation''' на вход системы передаются следующие сведения:
* информация о пользователе - инициаторе запроса;
* идентификатор ВСД, который необходимо аннулировать;
* дополнительная информация необходимая для аннулирования ВСД (дата аннулирования, причина аннулирования, сведения о лице (вет. враче) ответственном за аннулирование ВСД).
 
Результатом выполнения данной операции является
* ВСД переходит в статус '''"Аннулирован"'''.
* В журнал продукции предприятие-отправителя возвращается объем продукции, на которую был выдан аннулированный ВСД.
 
===Возможные сценарии===
При выполнении операции возможны следующие сценарии:<br />
# Запрос успешно обработан. Запрашиваемый ВСД аннулирован.
# Произошла ошибка при обработке запроса.
::* Некорректный запрос.
::* Внутренняя ошибка системы.
 
===Ограничения===
Аннулировать ветеринарный сертификат может любой врач, обслуживающий предприятие, на котором этот сертификат был выписан.
 
===Используемые пространства имён и типы===
{{столбцы}}
{{столбец}}
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[String255|bs:String255]]
** [[UUID|bs:UUID]]
** [[Decimal|bs:Decimal]]
** [[ComplexDate|bs:ComplexDate]]
** [[Year|bs:Year]]
** [[Month|bs:Month]]
** [[Day|bs:Day]]
** [[Hour|bs:Hour]]
 
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/production|prod]](<nowiki>http://api.vetrf.ru/schema/cdm/argus/production</nowiki>)
** [[ProductType|prod:ProductType]]
** [[Product|prod:Product]]
** [[SubProduct|prod:SubProduct]]
** [[ProductItem|prod:ProductItem]]
** [[ProductMarkingList|prod:ProductMarkingList]]
 
{{столбец}}
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/common|argc]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/common</nowiki>)
** [[User|argc:User]]
** [[Purpose|argc:Purpose]]
** [[Unit|argc:Unit]]
** [[PackingFormList|argc:PackingFormList]]
** [[PackingForm|argc:PackingForm]]
 
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/mercury/vet-document|vetd]] (<nowiki>http://api.vetrf.ru/schema/cdm/mercury/vet-document</nowiki>)
** [[WithdrawReason|vetd:WithdrawReason]]
** [[VetDocument|vetd:VetDocument]]
** [[VetDocumentType|vetd:VetDocumentType]]
** [[VetDocumentStatus|vetd:VetDocumentStatus]]
** [[Batch|vetd:Batch]]
** [[GoodsDate|vetd:GoodsDate]]
 
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]](<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
**[[Country|ikar:Country]]
 
{{столбец}}
*[[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]](<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
**[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
**[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
**[http://www.w3.org/TR/xmlschema-2/#date xs:date]
**[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
**[http://www.w3.org/TR/xmlschema-2/#integer xs:integer]
 
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/cerberus/enterprise|ent]](<nowiki>http://api.vetrf.ru/schema/cdm/cerberus/enterprise</nowiki>)
**[[BusinessMember|ent:BusinessMember]]
** [[BusinessEntity|ent:BusinessEntity]]
** [[Enterprise|ent:Enterprise]]
** [[ProducerList|ent:ProducerList]]
** [[Producer|ent:Producer]]
** [[EnterpriseRole|ent:EnterpriseRole]]
 
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/shipment|shp]](<nowiki>http://api.vetrf.ru/schema/cdm/argus/shipment</nowiki>)
** [[TransportInfo|shp:TransportInfo]]
** [[TransportationStorageType|shp:TransportationStorageType]]
** [[TransportNumber|shp:TransportNumber]]
 
{{столбцы/конец}}
 
===Общие отличия между версией для хозяйствующих субъектов и ветеринарных управлений ===
 
{| class="wikitable"
|-
! Различающиеся параметры !! Версия для хозяйствующих субъектов !! Версия для ветеринарных управлений
|-
| '''Пространство имён''' || merc:http://api.vetrf.ru/schema/cdm/mercury/applications || mercvu:http://api.vetrf.ru/schema/cdm/mercury/vu/applications
|-
| '''Имя сервиса''' || mercury-g2b.service || mercury-vu.service
|-
|}
 
==Данные запроса==
<!-- <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<merc:withdrawVetDocumentRequest xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/applications"
                                xmlns:base="http://api.vetrf.ru/schema/cdm/base"
                                xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
                                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <merc:localTransactionId>{xs:NCName}</merc:localTransactionId>
    <merc:initiator>
        <base:uuid>{base:UUID}</base:uuid>
        <com:login>{xs:NCName}</com:login>
    </merc:initiator>
    <merc:vetDocumentId>{base:UUID}</merc:vetDocumentId>
    <merc:withdrawReason>{bs:String255}</merc:withdrawReason>
    <merc:withdrawDate>{xs:date}</merc:withdrawDate>
    <merc:vetDoctor>
        <base:uuid>{bs:UUID}</base:uuid>
        <com:login>{bs:String255}</com:login>
    </merc:vetDoctor>
</merc:withdrawVetDocumentRequest>
</syntaxhighlight>
</div>
</div> -->
 
===Объект withdrawVetDocumentRequest===
Корневой элемент содержимого заявки. Содержит сведения для выполнения операции аннулирования ВСД.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''localTransactionId''' || Идентификатор заявки в клиентской системе.|| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1
|-
| [[#Объект ..Request/initiator|'''initiator''']] || Пользователь, инициирующий запрос к шлюзу. Ответственный за выполнение бизнес-операции. Должен быть указан или идентификатор, или логин. || [[User|argc:User]] || 1
|-
| '''vetDocumentId''' || Идентификатор ВСД, который аннулируется.|| [[UUID|bs:UUID]] || 1
|-
| '''withdrawReason''' || Причина аннулирования ВСД. || [[WithdrawReason|vetd:WithdrawReason]]|| 1
|-
| '''withdrawDate''' || Дата аннулирования ВСД. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| [[#Объект ..Request/vetDoctor|'''vetDoctor''']] || Ветеринарный врач, ответственный за аннулирование ВСД. || [[User|argc:User]] || 1
|}
 
===Объект [[#Объект withdrawVetDocumentRequest|..Request]]/'''initiator'''===
Содержит сведения о пользователе, зарегистрированном в системе Меркурий и инициирующим запрос к шлюзу.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID'''
| Идентификатор пользователя, зарегистрированного в системе Меркурий.
| [[UUID|bs:UUID]]
| rowspan=2 | 1 - обязательно должно быть заполнено хотя бы одно из полей, либо UUID, либо login.<br>
При указании обоих полей, приоритет у UUID.
|-
| '''login'''
| Логин пользователя.
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|}
 
===Объект [[#Объект withdrawVetDocumentRequest|..Request]]/'''vetDoctor'''===
Содержит сведения о пользователе - ветеринарном враче, ответственном за аннулирование ВСД.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID'''
| Идентификатор врача, зарегистрированного в системе Меркурий и осуществляющего аннулирование ВСД.
| [[UUID|bs:UUID]]
| rowspan=2 | 1 - обязательно должно быть заполнено хотя бы одно из полей, либо UUID, либо login.<br>
При указании обоих полей, приоритет у UUID.
|-
| '''login'''
| Логин врача, зарегистрированного в системе Меркурий и осуществляющего аннулирование ВСД.
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|}
 
==Данные ответа==
<!---
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате XML
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<WithdrawVetDocumentResponse xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                          xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/applications"
                          xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                          xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
                          xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
                          xmlns:ws="http://api.vetrf.ru/schema/cdm/mercury/ws-definitions"
                          xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
                          xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production"
                          xmlns:ship="http://api.vetrf.ru/schema/cdm/argus/shipment">
    <merc:vetDocument>
        <base:uuid>{bs:UUID}</base:uuid>
        <vet:issueDate>{xs:Date}</vet:issueDate>
        <vet:form>{vetd:VetDocument}</vet:form>
        <vet:type>{vetd:VetDocumentType}</vet:type>
        <vet:status>WITHDRAWN</vet:status>
        <vet:consignor>
            <ent:businessEntity>
                <base:uuid>{bs:UUID}</base:uuid>
                <base:guid>{bs:UUID}</base:guid>
            </ent:businessEntity>
            <ent:enterprise>
                <base:uuid>{bs:UUID}</base:uuid>
                <base:guid>{bs:GUID}</base:guid>
            </ent:enterprise>
      </vet:consignor>
      <vet:consignee>
          <ent:businessEntity>
              <base:uuid>{bs:UUID}</base:uuid>
              <base:guid>{bs:UUID}</base:guid>
          </ent:businessEntity>
          <ent:enterprise>
              <base:uuid>{bs:UUID}</base:uuid>
              <base:guid>{bs:UUID}</base:guid>
          </ent:enterprise>
    </vet:consignee>
    <vet:batch>
        <vet:productType>{vetd:ProductType}</vet:productType>
        <vet:product>
            <base:uuid>{bs:UUID}</base:uuid>
            <base:guid>{bs:UUID}</base:guid>
        </vet:product>
        <vet:subProduct>
            <base:uuid>{bs:UUID}</base:uuid>
            <base:guid>{bs:UUID}</base:guid>
        </vet:subProduct>
        <vet:productItem>
            <prod:name>{bs:String255}</prod:name>
        </vet:productItem>
        <vet:volume>{bs:Decimal}</vet:volume>
        <vet:unit>
            <base:uuid>{bs:UUID}</base:uuid>
            <base:guid>{bs:UUID}</base:guid>
        </vet:unit>
        <vet:packingList>
            <com:packingForm>
                <base:uuid>{bs:UUID}</base:uuid>
                <com:name>{bs:String255}</com:name>
            </com:packingForm>
        </vet:packingList>
        <vet:packingAmount>{xs:integer}</vet:packingAmount>
        <vet:dateOfProduction>
            <vet:firstDate>
                <base:year>{bs:Year}</base:year>
                <base:month>{bs:Month}</base:month>
                <base:day>{bs:Day}</base:day>
                <base:hour>{bs:Hour}</base:hour>
            </vet:firstDate>
            <vet:secondDate>
                <base:year>{bs:Year}</base:year>
                <base:month>{bs:Month}</base:month>
                <base:day>{bs:Day}</base:day>
                <base:hour>{bs:Hour}</base:hour>
            </vet:secondDate>
        </vet:dateOfProduction>
        <vet:expiryDate>
            <vet:firstDate>
                <base:year>{bs:Year}</base:year>
                <base:month>{bs:Month}</base:month>
                <base:day>{bs:Day}</base:day>
                <base:hour>{bs:Hour}</base:hour>
            </vet:firstDate>
            <vet:secondDate>
                <base:year>{bs:Year}</base:year>
                <base:month>{bs:Month}</base:month>
                <base:day>{bs:Day}</base:day>
                <base:hour>{bs:Hour}</base:hour>
            </vet:secondDate>
        </vet:expiryDate>
        <vet:perishable>{xs:boolean}</vet:perishable>
        <vet:countryOfOrigin>
            <base:uuid>{bs:UUID}</base:uuid>
            <base:guid>{bs:UUID}</base:guid>
        </vet:countryOfOrigin>
        <vet:producerList>
            <ent:producer>
                <ent:enterprise>
                    <base:uuid>{bs:UUID}</base:uuid>
                    <base:guid>{bs:UUID}</base:guid>
                </ent:enterprise>
                <ent:role>{ent:EnterpriseRole}</ent:role>
            </ent:producer>
        </vet:producerList>
        <vet:productMarkingList>
            <vet:productMarking>{bs:String255}</vet:productMarking>
        </vet:productMarkingList>
        <vet:lowGradeCargo>{xs:boolean}</vet:lowGradeCargo>
        <vet:owner>
            <base:uuid>{bs:UUID}</base:uuid>
            <base:guid>{bs:UUID}</base:guid>
        </vet:owner>
    </vet:batch>
    <vet:purpose>
        <base:uuid>{bs:UUID}</base:uuid>
        <base:guid>{bs:UUID}</base:guid>
    </vet:purpose>
    <vet:transportInfo>
        <ship:transportType>{shp:TransportType}</ship:transportType>
        <ship:transportNumber>
            <ship:vehicleNumber>{bs:String255}</ship:vehicleNumber>
        </ship:transportNumber>
    </vet:transportInfo>
    <vet:transportStorageType>{shp:TransportationStorageType}</vet:transportStorageType>
    <vet:waybillNumber>{bs:String255}</vet:waybillNumber>
    <vet:waybillDate>{xs:date}</vet:waybillDate>
    <vet:cargoExpertized>{xs:boolean}</vet:cargoExpertized>
    <vet:expertiseInfo>{bs:String255}</vet:expertiseInfo>
    <vet:confirmedBy>
        <com:fio>{bs:String255}</com:fio>
        <com:post>{bs:String255}</com:post>
    </vet:confirmedBy>
    <vet:locationProsperity>{bs:String255}</vet:locationProsperity>
    <vet:withdrawDate>{xs:dateTime}</vet:withdrawDate>
    <vet:withdrawReason>{bs:String255}</vet:withdrawReason>
    <vet:vetDoctor>{argc:User}</vet:vetDoctor>
</merc:vetDocument>
</syntaxhighlight>
</div>
</div>
-->
===Объект withdrawVetDocumentResponse===
Объект содержит сведения об аннулированном ВСД.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/vetDocument|'''vetDocument''' ]] || Сведения об аннулированном ВСД. || [[VetDocument|vetd:VetDocument]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/'''vetDocument''' ===
Объект содержит подробные сведения об аннулированном ВСД.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор ВСД в реестре ветеринарно-сопроводительных документов. ||[[UUID|bs:UUID]] || 1
|-
| '''issueSeries''' || Серия ВСД. || [[String255|bs:String255]] || 1
|-
| '''issueNumber''' || Номер ВСД. || [[String255|bs:String255]] || 1
|-
|'''issueDate''' || Дата оформления ВСД. || [http://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
|-
|'''form''' || Форма ВСД. || [[VetDocumentForm|vetd:VetDocumentForm]] || 1
|-
|'''type''' || Тип ВСД. || [[VetDocumentType|vetd:VetDocumentType]] || 1
|-
|'''status''' || Статус ВСД. || [[VetDocumentStatus|vetd:VetDocumentStatus]] || 1
|-
|[[#Объект ..Response/vetDocument/consignor|'''consignor''']] || Сведения об отправителе партии продукции. || [[BusinessMember|ent:BusinessMember]] || 1
|-
|[[#Объект ..Response/vetDocument/consignee|'''consignee''']] || Сведения о получателе партии продукции. || [[BusinessMember|ent:BusinessMember]] || 1
|-
|[[#Объект ..Response/vetDocument/batch|'''batch''']] || Сведения о партии продукции. || [[Batch|vetd:Batch]] || 1
|-
|[[#Объект ..Response/vetDocument/purpose|'''purpose''']] || Цель. Назначение груза. || [[Purpose|argc:Purpose]] || 1
|-
|[[#Объект ..Response/vetDocument/transportInfo|'''transportInfo''']] || Сведения о транспорте. || [[TransportInfo|shp:TransportInfo]] || 0..1
|-
|'''transportStorageType''' || Способ хранения продукции при перевозке. || [[TransportationStorageType|shp:TransportationStorageType]] || 1
|-
| [[#Объект ..Response/vetDocument/cargoReloadingPointList|'''cargoReloadingPointList''']]|| Сведения о маршруте следования (пунктах перегрузки).  || [[ShipmentRoute|shp:ShipmentRoute]] || 0..1
|-
|'''waybillNumber''' || Номер товарно-транспортной накладной. || [[String255|bs:String255]] || 0..1
|-
|'''waybillDate''' || Дата товарно-транспортной накладной.  || [http://www.w3.org/TR/xmlschema-2/#date xs:date] || 0..1
|-
|'''cargoExpertized''' || Проводилась ли ветсанэкспертиза:
* true - экспертиза проводилась;
* false - экспертиза не проводилась.
* Для типа продукции "Живые животные" поле отсутствует.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 0..1
|-
|'''expertiseInfo''' || Результат ветсанэкспертизы.
* Для типа продукции "Живые животные" поле отсутствует.
|| [[String255|bs:String255]] || 0..1
|-
|[[#Объект ..Response/vetDocument/confirmedBy|'''confirmedBy''']] || Государственный ветврач, выдавший ВСД. || [[User|argc:User]] || 1
|-
|'''locationProsperity''' || Благополучие местности. || [[String255|bs:String255]] || 1
|-
| '''animalSpentPeriod''' || Количество времени, которое животные находились на территории ТС.
* Данное поле указывается только для типа продукции "Живые животные"
|| [[AnimalSpentPeriod|vetd:AnimalSpentPeriod]] || 0..1
|-
| '''monthsSpent'''|| Кол-во месяцев нахождения животных на территории ТС.
* Данное поле указывается только для типа продукции "Живые животные".
|| [[String255|bs:String255]] || 0..1
|-
| '''quarantinePlace'''||Место проведения карантинирования.
* Данное поле указывается только для типа продукции "Живые животные".
|| [[String255|bs:String255]] || 0..1
|-
| '''quarantineDays'''|| Количество дней карантинирования.
* Данное поле указывается только для типа продукции "Живые животные".
|| [http://www.w3.org/TR/xmlschema-2/#int xs:int] || 0..1
|-
| '''specialMarks'''||Особые отметки. || [[String255|bs:String255]] || 0..1
|-
|'''withdrawDate''' || Дата и время аннулирования ВСД. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
|'''withdrawReason''' || Причина аннулирования ВСД.|| [[WithdrawReason|vetd:WithdrawReason]] || 1
|-
|[[#Объект ..Response/vetDocument/vetDoctor|'''vetDoctor''']] || Ветеринарный врач, аннулировавший ВСД. || [[User|argc:User]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''consignor'''===
Объект содержит сведения об отправителе партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/consignor/businessEntity|'''businessEntity''']] || Информация о хозяйствующем субъекте - отправителе партии продукции. || [[BusinessEntity|ent:BusinessEntity]] || 1
|-
| [[#Объект ..Response/vetDocument/consignor/enterprise|'''enterprise''']] || Информации о площадке - отправителе партии продукции.|| [[Enterprise|ent:Enterprise]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/consignor|consignor]]/'''businessEntity'''===
 
Объект содержит информацию о хозяйствующем субъекте - отправителе партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии хозяйствующего субъекта - отправителя партии продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта - отправителя партии продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/consignor|consignor]]/'''enterprise'''===
Объект содержит сведения о площадке - отправителе партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи о поднадзорном объекте в реестре РСХН. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор записи о поднадзорном объекте в реестре РСХН. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''consignee'''===
Объект содержит сведения о получателе партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/consignee/businessEntity|'''businessEntity''']] ||Информация о хозяйствующем субъекте - получателе партии продукции. || [[BusinessEntity|ent:BusinessEntity]] || 1
|-
| [[#Объект ..Response/vetDocument/consignee/enterprise|'''enterprise''']] || Информации о площадке - получателе партии продукции. || [[Enterprise|ent:Enterprise]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/consignee|consignee]]/'''businessEntity'''===
Объект содержит информацию о хозяйствующем субъекте - получателе партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии хозяйствующего субъекта - получателя партии продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта - получателя партии продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/consignee|consignee]]/'''enterprise'''===
Объект содержит сведения о площадке - получателе партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи о поднадзорном объекте в реестре РСХН. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор записи о поднадзорном объекте в реестре РСХН. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''batch'''===
 
Объект содержит сведения о партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''productType''' ||Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий. 
|| [[ProductType|prod:ProductType]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/product|'''product''']] || Продукция. Второй уровень иерархического справочника продукции ИС Меркурий.  || [[Product|prod:Product]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/subProduct|'''subProduct''']] ||Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.  || [[SubProduct|prod:SubProduct]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/productItem|'''productItem''']] || Наименование продукции в номенклатуре производителя.  || [[ProductItem|prod:ProductItem]] || 0..1
|-
| '''volume''' || Объем продукции, на который был выдан ВСД. Значение должно быть больше нуля.  || [[Decimal|bs:Decimal]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/unit|'''unit''']] || Единица измерения объема продукции.  || [[Unit|argc:Unit]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/packingList|'''packingList''']] ||Список видов упаковки.  || [[PackingFormList|argc:PackingFormList]] || 0..1
|-
| '''packingAmount''' || Общее количество единиц упаковки для партии.  || [http://www.w3.org/TR/xmlschema-2#integer xs:integer] || 0..1
|-
| [[#Объект ..Response/vetDocument/batch/dateOfProduction|'''dateOfProduction''']] || Дата выработки продукции. Может быть указана тремя способами: датой, диапазоном дат, строкой. В случае точной даты выработки указывается только первая компонента - firstDate. || [[GoodsDate|vetd:GoodsDate]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/expiryDate|'''expiryDate''']] || Дата окончания срока годности продукции. Может быть указана тремя способами: датой, диапазоном дат, строкой. В случае точной даты выработки указывается только первая компонента - firstDate. || [[GoodsDate|vetd:GoodsDate]] || 1
|-
| '''perishable''' || Описывает, является ли продукция скоропортящейся:
* true – скоропортящаяся;
* false – не скоропортящаяся.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| [[#Объект ..Response/vetDocument/batch/countryOfOrigin|'''countryOfOrigin''']] || Страна происхождения продукции. || [[Country|ikar:Country]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/producerList|'''producerList''']] || Список производителей продукции. || [[ProducerList|ent:ProducerList]] || 0..1
|-
| [[#Объект ..Response/vetDocument/batch/productMarkingList|'''productMarkingList''']] || Список маркировки, доступный для данного производителя. || [[ProductMarkingList|vetd:ProductMarkingList]] || 0..1
|-
| '''lowGradeCargo''' || Является ли продукция некачественной:
* true – некачественная;
* false – качественная.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| [[#Объект ..Response/vetDocument/batch/owner|'''owner''']] || Хозяйствующий субъект - владелец продукции.  || [[BusinessEntity|ent:BusinessEntity]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''product'''===
 
Объект содержит сведения о продукции; второй уровень иерархического справочника продукции ИС Меркурий.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''subProduct'''===
 
Объект содержит сведения о видах продукции; третий уровень иерархического справочника продукции ИС Меркурий.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии вида продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор продукции.  || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''productItem'''===
Объект содержит сведения о наименовании продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID'''
| Идентификатор версии наименования продукции.
| [[UUID|bs:UUID]]
|rowspan=2 | 1 - возвращается или UUID или name, либо оба значения.
|-
| '''name'''
| Наименование продукции в соответствии с номенклатурой производителя.
| [http://www.w3.org/TR/xmlschema-2/#string xs:string]
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''unit'''===
Объект содержит сведения о единице измерения объема партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии единицы измерения. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор единицы измерения. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''packingList'''===
 
Объект содержит сведения о списке видов упаковки, которые используются для партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/batch/packingList/packingForm|'''packingForm''']] || Вид упаковки.  || [[PackingForm|argc:PackingForm]] || 0..*
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/packingList|packingList]]/'''packingForm'''===
Объект содержит сведения о виде упаковки, которая используются для партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор упаковки.  || [[UUID|bs:UUID]] || 1
|-
| '''name''' || Наименование конкретного вида упаковки. || [[String255|bs:String255]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''dateOfProduction'''===
 
Объект содержит информацию о дате (или интервале дат) производства партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/batch/dateOfProduction/firstDate|'''firstDate''']] || Дата производства партии продукции или начальная дата, в случае указания интервала дат производства партии продукции. || [[ComplexDate|bs:ComplexDate]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/dateOfProduction/secondDate|'''secondDate''']] || Конечная дата интервала дат, в который была произведена партия продукции. || [[ComplexDate|bs:ComplexDate]] || 0..1
|-
| '''informalDate''' || Дата производства в виде строки. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/dateOfProduction|dateOfProduction]]/'''firstDate'''===
Объект содержит информацию о дате производства партии продукции или начальной дате, если был указан интервал.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''year''' || Год производства партии продукции. || [[Year|bs:Year]] || 1
|-
| '''month''' || Месяц производства партии продукции.|| [[Month|bs:Month]] || 1
|-
| '''day''' || День производства партии продукции.
* День производства может не указываться для не скоропортящейся продукции.
|| [[Day|bs:Day]] || 0..1
|-
| '''hour''' || Час производства партии продукции.
* Час производства может не указываться для не скоропортящейся продукции.
|| [[Hour|bs:Hour]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/dateOfProduction|dateOfProduction]]/'''secondDate'''===
Объект содержит информацию о конечной дате в интервале дат производства партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''year''' || Год производства партии продукции. || [[Year|bs:Year]] || 1
|-
| '''month''' || Месяц производства партии продукции.|| [[Month|bs:Month]] || 1
|-
| '''day''' || День производства партии продукции.
* День производства может не указываться для не скоропортящейся продукции.
|| [[Day|bs:Day]] || 0..1
|-
| '''hour''' || Час производства партии продукции.
* Час производства может не указываться для не скоропортящейся продукции.
|| [[Hour|bs:Hour]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''expiryDate'''===
Объект содержит информацию о дате (или интервале дат) истечения срока годности партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/batch/expiryDate/firstDate|'''firstDate''']] || Дата истечения срока годности партии продукции или начальная дата, в случае указания интервала дат истечения срока годности продукции. || [[ComplexDate|bs:ComplexDate]] || 1
|-
| [[#Объект ..Response/vetDocument/batch/expiryDate/secondDate|'''secondDate''']] || Конечная дата интервала дат, истечения срока годности партии продукции. || [[ComplexDate|bs:ComplexDate]] || 0..1
|-
| '''informalDate''' || Дата истечения срока годности в виде строки. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/expiryDate|expiryDate]]/'''firstDate'''===
Объект содержит информацию о дате истечения срока годности партии продукции или начальной дате, если был указан интервал.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''year''' || Год истечения срока годности партии продукции. || [[Year|bs:Year]] || 1
|-
| '''month''' || Месяц истечения срока годности партии продукции.|| [[Month|bs:Month]] || 1
|-
| '''day''' || День истечения срока годности партии продукции.
* День истечения срока годности может не указываться для не скоропортящейся продукции.
|| [[Day|bs:Day]] || 0..1
|-
| '''hour''' || Час истечения срока годности партии продукции.
* Час истечения срока годности может не указываться для не скоропортящейся продукции.
|| [[Hour|bs:Hour]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/expiryDate|expiryDate]]/'''secondDate'''===
Объект содержит информацию о конечной дате в интервале дат истечения срока годности партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''year''' || Год истечения срока годности партии продукции. || [[Year|bs:Year]] || 1
|-
| '''month''' || Месяц истечения срока годности партии продукции.|| [[Month|bs:Month]] || 1
|-
| '''day''' || День истечения срока годности партии продукции.
* День истечения срока годности  может не указываться для не скоропортящейся продукции.
|| [[Day|bs:Day]] || 0..1
|-
| '''hour''' || Час истечения срока годности партии продукции.
* Час истечения срока годности может не указываться для не скоропортящейся продукции.
|| [[Hour|bs:Hour]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''countryOfOrigin'''===
Объект содержит сведения о стране-происхождения партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии страны происхождения партии продукции.|| [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор страны происхождения партии продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''producerList'''===
Объект содержит сведения о списке производителей партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/batch/producerList/producer|'''producer''']] || Производитель партии продукции. || [[Producer|ent:Producer]] || 0..*
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/producerList|producerList]]/'''producer'''===
Объект содержит сведения о производителе партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/vetDocument/batch/producerList/producer/enterprise|'''enterprise''']] || Информация о предприятии-производителе. || [[Enterprise|ent:Enterprise]] || 1
|-
| '''role''' || Роль предприятия:
* UNKNOWN - роль не определена;
* PRODUCER - производитель продукции.
|| [[EnterpriseRole|ent:EnterpriseRole]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/[[#Объект ..Response/vetDocument/batch/producerList|producerList]]/[[#Объект ..Response/vetDocument/batch/producerList/producer|producer]]/'''enterprise'''===
Объект содержит сведения о предприятие-производителе продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии  предприятия-производителя продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор предприятия-производителя продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''productMarkingList'''===
Объект содержит сведения о списке маркировки.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''productMarking''' || Строка с маркировкой продукции. || [[String255|bs:String255]] || 0..*
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/batch|batch]]/'''owner'''===
Объект содержит сведения о хозяйствующем субъекте-владельце продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии хозяйствующего субъекта - владельца продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта - владельца продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''purpose'''===
 
Объект содержит информацию о цели перемещения партии продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор записи в справочнике целей.  || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор записи в справочнике целей. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''transportInfo'''===
 
Объект содержит информацию о транспорте в котором перевозилась партия продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''transportType''' || Тип транспортного средства. || [[TransportInfo|shp:TransportInfo]] || 1
|-
| [[#Объект ..Response/vetDocument/transportInfo/transportNumber|'''transportNumber''']] || Номер транспортного средства. || [[TransportNumber|shp:TransportNumber]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/transportInfo|transportInfo]]/'''transportNumber'''===
Объект содержит информацию о номере транспортного средства.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''vehicleNumber''' || Номер транспортного средства. || [[String255|bs:String255]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''cargoReloadingPointList'''===
 
Объект содержит информацию о списке пунктов перегрузки.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/vetDocument/cargoReloadingPointList/cargoReloadingPoint|'''cargoReloadingPoint''']] || Пункт перегрузки партии продукции в другое транспортное средство.|| [[CargoReloadingPoint |shp:CargoReloadingPoint]] || 0..*
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Response/vetDocument/cargoReloadingPointList|cargoReloadingPointList]]/'''cargoReloadingPoint'''===
Объект содержит информацию о пункте перегрузки.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''name''' || Название пункта перегрузки. || [[String255|bs:String255]] || 1
|-
| [[#Объект ..Response/vetDocument/cargoReloadingPointList/cargoReloadingPoint/nextTransport|'''nextTransport''']]|| Сведения о дальнейшем транспорте. || [[TransportInfo | shp:TransportInfo ]]|| 1
|}
 
===Объект [[#Объект withdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/[[#Объект ..Repsponse/vetDocument/cargoReloadingPointList|cargoReloadingPointList]]/[[#Объект ..Response/vetDocument/cargoReloadingPointList/cargoReloadingPoint|cargoReloadingPoint]]/'''nextTransport'''===
Объект содержит сведения о транспорте, которым далее последует транспортная партия.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''transportType''' || Тип транспортного средства. || [[TransportType |shp:TransportType]] || 1
|-
| '''transportNumber''' || Номер транспортного средства. || [[TransportNumber | shp:TransportNumber]] || 1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''confirmedBy'''===
 
Объект содержит информацию о враче, выдавшем ВСД.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''fio''' || ФИО врача, выдавшего ВСД. || [[String255|bs:String255]] || 1
|-
| '''post''' || Должность врача, выдавшего ВСД. || [[String255|bs:String255]] || 0..1
|}
 
===Объект [[#Объект WithdrawVetDocumentResponse|..Response]]/[[#Объект ..Response/vetDocument|vetDocument]]/'''vetDoctor'''===
 
Объект содержит информацию о враче, аннулировавшем ВСД.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор врача, зарегистрированного в системе Меркурий и осуществившего аннулирование ВСД. || [[UUID|bs:UUID]] || 1
|-
| '''login''' || Логин врача, зарегистрированного в системе Меркурий и осуществившего аннулирование ВСД.|| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1
|}
 
==Примеры запросов==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Аннулирование ВСД для ветеринарного управления.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                  xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/applications"
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base"
                  xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
                  xmlns:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header/>
  <soapenv:Body>
      <ws:submitApplicationRequest>
        <ws:apiKey>apiKey</ws:apiKey>
        <app:application>
            <app:serviceId>mercury-vu.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2017-01-13T17:03:00</app:issueDate>
            <app:data>
              <mercvu:withdrawVetDocumentRequest>
                  <mercvu:localTransactionId>a1</mercvu:localTransactionId>
                  <mercvu:initiator>
                    <com:login>login</com:login>
                  </mercvu:initiator>
                  <mercvu:vetDocumentId>4995ba5e-7fd3-4ded-b3eb-9778a04503cd</mercvu:vetDocumentId>
                  <mercvu:withdrawReason>Неверно указан объём продукции</mercvu:withdrawReason>
                  <mercvu:withdrawDate>2017-01-13T00:00:00</mercvu:withdrawDate>
                  <mercvu:vetDoctor>
                    <com:login>login</com:login>
                  </mercvu:vetDoctor>
              </mercvu:withdrawVetDocumentRequest>
            </app:data>
        </app:application>
      </ws:submitApplicationRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Аннулирование ВСД для хозяйствующего субъекта.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/application/ws-definitions"
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                  xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/applications"
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base"
                  xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
                  xmlns:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header/>
  <soapenv:Body>
      <ws:submitApplicationRequest>
        <ws:apiKey>apiKey</ws:apiKey>
        <app:application>
            <app:serviceId>mercury-g2b.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2015-09-02T17:03:00</app:issueDate>
            <app:data>
              <merc:withdrawVetDocumentRequest>
                  <merc:localTransactionId>a1</merc:localTransactionId>
                  <merc:initiator>
                    <com:login>a123</com:login>
                  </merc:initiator>
                  <merc:vetDocumentId>vetDocumentId</merc:vetDocumentId>
                  <merc:withdrawReason>Неверно указан объём продукции</merc:withdrawReason>
                  <merc:withdrawDate>2015-10-05T00:00:00</merc:withdrawDate>
                  <merc:vetDoctor>
                    <com:login>a123</com:login>
                  </merc:vetDoctor>
              </merc:withdrawVetDocumentRequest>
            </app:data>
        </app:application>
      </ws:submitApplicationRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
 
==Коды ошибок==
 
{| class="wikitable"
|-
! Код ошибки !! Описание
|-
| MERC16001 || Инициатор запроса должен являться хозяйствующим субъектом-отправителем, указанном в ветеринарно-сопроводительном документе.
|-
| MERC16002 || В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции.
|-
| MERC16003 || Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции.
|-
| MERC16004 || В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC16005 || Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC16206 || В запросе отсутствуют сведения о ветеринарно-сопроводительном документе.
|-
| MERC16222 || Идентификатор ветеринарно-сопроводительного документа (UUID) обязателен для заполнения.
|-
| MERC16224 || Ветеринарно-сопроводительный документ не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC16266 || Ветеринарно-сопроводительный документ не должен быть производственным.
|-
| MERC16267 || Ветеринарно-сопроводительный документ не должен быть техническим.
|-
| MERC16268 || Ветеринарно-сопроводительный документ должен быть в состоянии "оформлен" (т.е. не погашен).
|-
| MERC16269 || Ветеринарно-сопроводительный документ должен быть в состоянии "оформлен" (т.е. не аннулирован).
|-
| MERC16270 || Ветеринарно-сопроводительный документ должен быть в состоянии "оформлен".
|-
| MERC16271 || Дата аннулирования в ветеринарно-сопроводительном документе обязательна для заполнения
|-
| MERC16272 || Причина аннулирования в ветеринарно-сопроводительном документе обязательна для заполнения
|-
| MERC16273|| Причина аннулирования в ветеринарно-сопроводительном документе превышает допустимую длину текста (250). 
|}
 
[[#top|Вернуться к началу &uarr;]]
[[Category:Ветис.API]]
[[Category:Аннулирование ВСД]]
[[Category:Ветис.API для ветеринарных управлений]]

Текущая версия на 11:17, 13 января 2017

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

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

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

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

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

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

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

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

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

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

Ограничения

Аннулировать ветеринарный сертификат может любой врач, обслуживающий предприятие, на котором этот сертификат был выписан.

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



Общие отличия между версией для хозяйствующих субъектов и ветеринарных управлений

Различающиеся параметры Версия для хозяйствующих субъектов Версия для ветеринарных управлений
Пространство имён merc:http://api.vetrf.ru/schema/cdm/mercury/applications mercvu:http://api.vetrf.ru/schema/cdm/mercury/vu/applications
Имя сервиса mercury-g2b.service mercury-vu.service

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

Объект withdrawVetDocumentRequest

Корневой элемент содержимого заявки. Содержит сведения для выполнения операции аннулирования ВСД.

Поле Описание Тип Обязательность
localTransactionId Идентификатор заявки в клиентской системе. xs:NCName 1
initiator Пользователь, инициирующий запрос к шлюзу. Ответственный за выполнение бизнес-операции. Должен быть указан или идентификатор, или логин. argc:User 1
vetDocumentId Идентификатор ВСД, который аннулируется. bs:UUID 1
withdrawReason Причина аннулирования ВСД. vetd:WithdrawReason 1
withdrawDate Дата аннулирования ВСД. xs:dateTime 1
vetDoctor Ветеринарный врач, ответственный за аннулирование ВСД. argc:User 1

Объект ..Request/initiator

Содержит сведения о пользователе, зарегистрированном в системе Меркурий и инициирующим запрос к шлюзу.

Поле Описание Тип Обязательность
UUID Идентификатор пользователя, зарегистрированного в системе Меркурий. bs:UUID 1 - обязательно должно быть заполнено хотя бы одно из полей, либо UUID, либо login.

При указании обоих полей, приоритет у UUID.

login Логин пользователя. xs:NCName

Объект ..Request/vetDoctor

Содержит сведения о пользователе - ветеринарном враче, ответственном за аннулирование ВСД.

Поле Описание Тип Обязательность
UUID Идентификатор врача, зарегистрированного в системе Меркурий и осуществляющего аннулирование ВСД. bs:UUID 1 - обязательно должно быть заполнено хотя бы одно из полей, либо UUID, либо login.

При указании обоих полей, приоритет у UUID.

login Логин врача, зарегистрированного в системе Меркурий и осуществляющего аннулирование ВСД. xs:NCName

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

Объект withdrawVetDocumentResponse

Объект содержит сведения об аннулированном ВСД.

Поле Описание Тип Обязательность
vetDocument Сведения об аннулированном ВСД. vetd:VetDocument 0..1

Объект ..Response/vetDocument

Объект содержит подробные сведения об аннулированном ВСД.

Поле Описание Тип Обязательность
UUID Идентификатор ВСД в реестре ветеринарно-сопроводительных документов. bs:UUID 1
issueSeries Серия ВСД. bs:String255 1
issueNumber Номер ВСД. bs:String255 1
issueDate Дата оформления ВСД. xs:date 1
form Форма ВСД. vetd:VetDocumentForm 1
type Тип ВСД. vetd:VetDocumentType 1
status Статус ВСД. vetd:VetDocumentStatus 1
consignor Сведения об отправителе партии продукции. ent:BusinessMember 1
consignee Сведения о получателе партии продукции. ent:BusinessMember 1
batch Сведения о партии продукции. vetd:Batch 1
purpose Цель. Назначение груза. argc:Purpose 1
transportInfo Сведения о транспорте. shp:TransportInfo 0..1
transportStorageType Способ хранения продукции при перевозке. shp:TransportationStorageType 1
cargoReloadingPointList Сведения о маршруте следования (пунктах перегрузки). shp:ShipmentRoute 0..1
waybillNumber Номер товарно-транспортной накладной. bs:String255 0..1
waybillDate Дата товарно-транспортной накладной. xs:date 0..1
cargoExpertized Проводилась ли ветсанэкспертиза:
  • true - экспертиза проводилась;
  • false - экспертиза не проводилась.
  • Для типа продукции "Живые животные" поле отсутствует.
 xs:boolean 0..1
expertiseInfo Результат ветсанэкспертизы.
  • Для типа продукции "Живые животные" поле отсутствует.
 bs:String255 0..1
confirmedBy Государственный ветврач, выдавший ВСД. argc:User 1
locationProsperity Благополучие местности. bs:String255 1
animalSpentPeriod Количество времени, которое животные находились на территории ТС.
  • Данное поле указывается только для типа продукции "Живые животные"
 vetd:AnimalSpentPeriod 0..1
monthsSpent Кол-во месяцев нахождения животных на территории ТС.
  • Данное поле указывается только для типа продукции "Живые животные".
 bs:String255 0..1
quarantinePlace Место проведения карантинирования.
  • Данное поле указывается только для типа продукции "Живые животные".
 bs:String255 0..1
quarantineDays Количество дней карантинирования.
  • Данное поле указывается только для типа продукции "Живые животные".
 xs:int 0..1
specialMarks Особые отметки. bs:String255 0..1
withdrawDate Дата и время аннулирования ВСД. xs:dateTime 1
withdrawReason Причина аннулирования ВСД. vetd:WithdrawReason 1
vetDoctor Ветеринарный врач, аннулировавший ВСД. argc:User 1

Объект ..Response/vetDocument/consignor

Объект содержит сведения об отправителе партии продукции.

Поле Описание Тип данных Обязательность
businessEntity Информация о хозяйствующем субъекте - отправителе партии продукции. ent:BusinessEntity 1
enterprise Информации о площадке - отправителе партии продукции. ent:Enterprise 1

Объект ..Response/vetDocument/consignor/businessEntity

Объект содержит информацию о хозяйствующем субъекте - отправителе партии продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии хозяйствующего субъекта - отправителя партии продукции. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта - отправителя партии продукции. bs:UUID 1

Объект ..Response/vetDocument/consignor/enterprise

Объект содержит сведения о площадке - отправителе партии продукции.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи о поднадзорном объекте в реестре РСХН. bs:UUID 1
GUID Глобальный идентификатор записи о поднадзорном объекте в реестре РСХН. bs:UUID 1

Объект ..Response/vetDocument/consignee

Объект содержит сведения о получателе партии продукции.

Поле Описание Тип данных Обязательность
businessEntity Информация о хозяйствующем субъекте - получателе партии продукции. ent:BusinessEntity 1
enterprise Информации о площадке - получателе партии продукции. ent:Enterprise 1

Объект ..Response/vetDocument/consignee/businessEntity

Объект содержит информацию о хозяйствующем субъекте - получателе партии продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии хозяйствующего субъекта - получателя партии продукции. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта - получателя партии продукции. bs:UUID 1

Объект ..Response/vetDocument/consignee/enterprise

Объект содержит сведения о площадке - получателе партии продукции.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи о поднадзорном объекте в реестре РСХН. bs:UUID 1
GUID Глобальный идентификатор записи о поднадзорном объекте в реестре РСХН. bs:UUID 1

Объект ..Response/vetDocument/batch

Объект содержит сведения о партии продукции.

Поле Описание Тип данных Обязательность
productType Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий. prod:ProductType 1
product Продукция. Второй уровень иерархического справочника продукции ИС Меркурий. prod:Product 1
subProduct Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий. prod:SubProduct 1
productItem Наименование продукции в номенклатуре производителя. prod:ProductItem 0..1
volume Объем продукции, на который был выдан ВСД. Значение должно быть больше нуля. bs:Decimal 1
unit Единица измерения объема продукции. argc:Unit 1
packingList Список видов упаковки. argc:PackingFormList 0..1
packingAmount Общее количество единиц упаковки для партии. xs:integer 0..1
dateOfProduction Дата выработки продукции. Может быть указана тремя способами: датой, диапазоном дат, строкой. В случае точной даты выработки указывается только первая компонента - firstDate. vetd:GoodsDate 1
expiryDate Дата окончания срока годности продукции. Может быть указана тремя способами: датой, диапазоном дат, строкой. В случае точной даты выработки указывается только первая компонента - firstDate. vetd:GoodsDate 1
perishable Описывает, является ли продукция скоропортящейся:
  • true – скоропортящаяся;
  • false – не скоропортящаяся.
 xs:boolean 1
countryOfOrigin Страна происхождения продукции. ikar:Country 1
producerList Список производителей продукции. ent:ProducerList 0..1
productMarkingList Список маркировки, доступный для данного производителя. vetd:ProductMarkingList 0..1
lowGradeCargo Является ли продукция некачественной:
  • true – некачественная;
  • false – качественная.
 xs:boolean 1
owner Хозяйствующий субъект - владелец продукции. ent:BusinessEntity 1

Объект ..Response/vetDocument/batch/product

Объект содержит сведения о продукции; второй уровень иерархического справочника продукции ИС Меркурий.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии продукции. bs:UUID 1
GUID Глобальный идентификатор продукции. bs:UUID 1

Объект ..Response/vetDocument/batch/subProduct

Объект содержит сведения о видах продукции; третий уровень иерархического справочника продукции ИС Меркурий.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии вида продукции. bs:UUID 1
GUID Глобальный идентификатор продукции. bs:UUID 1

Объект ..Response/vetDocument/batch/productItem

Объект содержит сведения о наименовании продукции.

Поле Описание Тип Обязательность
UUID Идентификатор версии наименования продукции. bs:UUID 1 - возвращается или UUID или name, либо оба значения.
name Наименование продукции в соответствии с номенклатурой производителя. xs:string

Объект ..Response/vetDocument/batch/unit

Объект содержит сведения о единице измерения объема партии продукции.

Поле Описание Тип Обязательность
UUID Идентификатор версии единицы измерения. bs:UUID 1
GUID Глобальный идентификатор единицы измерения. bs:UUID 1

Объект ..Response/vetDocument/batch/packingList

Объект содержит сведения о списке видов упаковки, которые используются для партии продукции.

Поле Описание Тип данных Обязательность
packingForm Вид упаковки. argc:PackingForm 0..*

Объект ..Response/vetDocument/batch/packingList/packingForm

Объект содержит сведения о виде упаковки, которая используются для партии продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор упаковки. bs:UUID 1
name Наименование конкретного вида упаковки. bs:String255 1

Объект ..Response/vetDocument/batch/dateOfProduction

Объект содержит информацию о дате (или интервале дат) производства партии продукции.

Поле Описание Тип данных Обязательность
firstDate Дата производства партии продукции или начальная дата, в случае указания интервала дат производства партии продукции. bs:ComplexDate 1
secondDate Конечная дата интервала дат, в который была произведена партия продукции. bs:ComplexDate 0..1
informalDate Дата производства в виде строки. bs:String255 0..1

Объект ..Response/vetDocument/batch/dateOfProduction/firstDate

Объект содержит информацию о дате производства партии продукции или начальной дате, если был указан интервал.

Поле Описание Тип данных Обязательность
year Год производства партии продукции. bs:Year 1
month Месяц производства партии продукции. bs:Month 1
day День производства партии продукции.
  • День производства может не указываться для не скоропортящейся продукции.
 bs:Day 0..1
hour Час производства партии продукции.
  • Час производства может не указываться для не скоропортящейся продукции.
 bs:Hour 0..1

Объект ..Response/vetDocument/batch/dateOfProduction/secondDate

Объект содержит информацию о конечной дате в интервале дат производства партии продукции.

Поле Описание Тип данных Обязательность
year Год производства партии продукции. bs:Year 1
month Месяц производства партии продукции. bs:Month 1
day День производства партии продукции.
  • День производства может не указываться для не скоропортящейся продукции.
 bs:Day 0..1
hour Час производства партии продукции.
  • Час производства может не указываться для не скоропортящейся продукции.
 bs:Hour 0..1

Объект ..Response/vetDocument/batch/expiryDate

Объект содержит информацию о дате (или интервале дат) истечения срока годности партии продукции.

Поле Описание Тип данных Обязательность
firstDate Дата истечения срока годности партии продукции или начальная дата, в случае указания интервала дат истечения срока годности продукции. bs:ComplexDate 1
secondDate Конечная дата интервала дат, истечения срока годности партии продукции. bs:ComplexDate 0..1
informalDate Дата истечения срока годности в виде строки. bs:String255 0..1

Объект ..Response/vetDocument/batch/expiryDate/firstDate

Объект содержит информацию о дате истечения срока годности партии продукции или начальной дате, если был указан интервал.

Поле Описание Тип данных Обязательность
year Год истечения срока годности партии продукции. bs:Year 1
month Месяц истечения срока годности партии продукции. bs:Month 1
day День истечения срока годности партии продукции.
  • День истечения срока годности может не указываться для не скоропортящейся продукции.
 bs:Day 0..1
hour Час истечения срока годности партии продукции.
  • Час истечения срока годности может не указываться для не скоропортящейся продукции.
 bs:Hour 0..1

Объект ..Response/vetDocument/batch/expiryDate/secondDate

Объект содержит информацию о конечной дате в интервале дат истечения срока годности партии продукции.

Поле Описание Тип данных Обязательность
year Год истечения срока годности партии продукции. bs:Year 1
month Месяц истечения срока годности партии продукции. bs:Month 1
day День истечения срока годности партии продукции.
  • День истечения срока годности может не указываться для не скоропортящейся продукции.
 bs:Day 0..1
hour Час истечения срока годности партии продукции.
  • Час истечения срока годности может не указываться для не скоропортящейся продукции.
 bs:Hour 0..1

Объект ..Response/vetDocument/batch/countryOfOrigin

Объект содержит сведения о стране-происхождения партии продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии страны происхождения партии продукции. bs:UUID 1
GUID Глобальный идентификатор страны происхождения партии продукции. bs:UUID 1

Объект ..Response/vetDocument/batch/producerList

Объект содержит сведения о списке производителей партии продукции.

Поле Описание Тип данных Обязательность
producer Производитель партии продукции. ent:Producer 0..*

Объект ..Response/vetDocument/batch/producerList/producer

Объект содержит сведения о производителе партии продукции.

Поле Описание Тип данных Обязательность
enterprise Информация о предприятии-производителе. ent:Enterprise 1
role Роль предприятия:
  • UNKNOWN - роль не определена;
  • PRODUCER - производитель продукции.
 ent:EnterpriseRole 1

Объект ..Response/vetDocument/batch/producerList/producer/enterprise

Объект содержит сведения о предприятие-производителе продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии предприятия-производителя продукции. bs:UUID 1
GUID Глобальный идентификатор предприятия-производителя продукции. bs:UUID 1

Объект ..Response/vetDocument/batch/productMarkingList

Объект содержит сведения о списке маркировки.

Поле Описание Тип данных Обязательность
productMarking Строка с маркировкой продукции. bs:String255 0..*

Объект ..Response/vetDocument/batch/owner

Объект содержит сведения о хозяйствующем субъекте-владельце продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии хозяйствующего субъекта - владельца продукции. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта - владельца продукции. bs:UUID 1

Объект ..Response/vetDocument/purpose

Объект содержит информацию о цели перемещения партии продукции.

Поле Описание Тип данных Обязательность
UUID Идентификатор записи в справочнике целей. bs:UUID 1
GUID Глобальный идентификатор записи в справочнике целей. bs:UUID 1

Объект ..Response/vetDocument/transportInfo

Объект содержит информацию о транспорте в котором перевозилась партия продукции.

Поле Описание Тип данных Обязательность
transportType Тип транспортного средства. shp:TransportInfo 1
transportNumber Номер транспортного средства. shp:TransportNumber 1

Объект ..Response/vetDocument/transportInfo/transportNumber

Объект содержит информацию о номере транспортного средства.

Поле Описание Тип данных Обязательность
vehicleNumber Номер транспортного средства. bs:String255 1

Объект ..Response/vetDocument/cargoReloadingPointList

Объект содержит информацию о списке пунктов перегрузки.

Поле Описание Тип Обязательность
cargoReloadingPoint Пункт перегрузки партии продукции в другое транспортное средство. shp:CargoReloadingPoint 0..*

Объект ..Response/vetDocument/cargoReloadingPointList/cargoReloadingPoint

Объект содержит информацию о пункте перегрузки.

Поле Описание Тип Обязательность
name Название пункта перегрузки. bs:String255 1
nextTransport Сведения о дальнейшем транспорте. shp:TransportInfo 1

Объект ..Response/vetDocument/cargoReloadingPointList/cargoReloadingPoint/nextTransport

Объект содержит сведения о транспорте, которым далее последует транспортная партия.

Поле Описание Тип Обязательность
transportType Тип транспортного средства. shp:TransportType 1
transportNumber Номер транспортного средства. shp:TransportNumber 1

Объект ..Response/vetDocument/confirmedBy

Объект содержит информацию о враче, выдавшем ВСД.

Поле Описание Тип данных Обязательность
fio ФИО врача, выдавшего ВСД. bs:String255 1
post Должность врача, выдавшего ВСД. bs:String255 0..1

Объект ..Response/vetDocument/vetDoctor

Объект содержит информацию о враче, аннулировавшем ВСД.

Поле Описание Тип Обязательность
UUID Идентификатор врача, зарегистрированного в системе Меркурий и осуществившего аннулирование ВСД. bs:UUID 1
login Логин врача, зарегистрированного в системе Меркурий и осуществившего аннулирование ВСД. xs:NCName 1

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

Аннулирование ВСД для ветеринарного управления. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                  xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/applications"
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base" 
                  xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 
                  xmlns:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document" 
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:submitApplicationRequest>
         <ws:apiKey>apiKey</ws:apiKey>
         <app:application>
            <app:serviceId>mercury-vu.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2017-01-13T17:03:00</app:issueDate>
            <app:data>
               <mercvu:withdrawVetDocumentRequest>
                  <mercvu:localTransactionId>a1</mercvu:localTransactionId>
                  <mercvu:initiator>
                     <com:login>login</com:login>
                  </mercvu:initiator>
                  <mercvu:vetDocumentId>4995ba5e-7fd3-4ded-b3eb-9778a04503cd</mercvu:vetDocumentId>
                  <mercvu:withdrawReason>Неверно указан объём продукции</mercvu:withdrawReason>
                  <mercvu:withdrawDate>2017-01-13T00:00:00</mercvu:withdrawDate>
                  <mercvu:vetDoctor>
                     <com:login>login</com:login>
                  </mercvu:vetDoctor>
               </mercvu:withdrawVetDocumentRequest>
            </app:data>
         </app:application>
      </ws:submitApplicationRequest>
   </soapenv:Body>
</soapenv:Envelope>


Аннулирование ВСД для хозяйствующего субъекта. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                  xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/applications"
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base" 
                  xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 
                  xmlns:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document" 
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:submitApplicationRequest>
         <ws:apiKey>apiKey</ws:apiKey>
         <app:application>
            <app:serviceId>mercury-g2b.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2015-09-02T17:03:00</app:issueDate>
            <app:data>
               <merc:withdrawVetDocumentRequest>
                  <merc:localTransactionId>a1</merc:localTransactionId>
                  <merc:initiator>
                     <com:login>a123</com:login>
                  </merc:initiator>
                  <merc:vetDocumentId>vetDocumentId</merc:vetDocumentId>
                  <merc:withdrawReason>Неверно указан объём продукции</merc:withdrawReason>
                  <merc:withdrawDate>2015-10-05T00:00:00</merc:withdrawDate>
                  <merc:vetDoctor>
                     <com:login>a123</com:login>
                  </merc:vetDoctor>
               </merc:withdrawVetDocumentRequest>
            </app:data>
         </app:application>
      </ws:submitApplicationRequest>
   </soapenv:Body>
</soapenv:Envelope>

Коды ошибок

Код ошибки Описание
MERC16001 Инициатор запроса должен являться хозяйствующим субъектом-отправителем, указанном в ветеринарно-сопроводительном документе.
MERC16002 В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции.
MERC16003 Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции.
MERC16004 В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН.
MERC16005 Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC16206 В запросе отсутствуют сведения о ветеринарно-сопроводительном документе.
MERC16222 Идентификатор ветеринарно-сопроводительного документа (UUID) обязателен для заполнения.
MERC16224 Ветеринарно-сопроводительный документ не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC16266 Ветеринарно-сопроводительный документ не должен быть производственным.
MERC16267 Ветеринарно-сопроводительный документ не должен быть техническим.
MERC16268 Ветеринарно-сопроводительный документ должен быть в состоянии "оформлен" (т.е. не погашен).
MERC16269 Ветеринарно-сопроводительный документ должен быть в состоянии "оформлен" (т.е. не аннулирован).
MERC16270 Ветеринарно-сопроводительный документ должен быть в состоянии "оформлен".
MERC16271 Дата аннулирования в ветеринарно-сопроводительном документе обязательна для заполнения
MERC16272 Причина аннулирования в ветеринарно-сопроводительном документе обязательна для заполнения
MERC16273 Причина аннулирования в ветеринарно-сопроводительном документе превышает допустимую длину текста (250).

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

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