GetVetDocumentByUuidOperation

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

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

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

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

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

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

Запрашиваться могут только те ВСД, которые ветеринарное управление инициатор оформило. Если запрос оформляется от имени предприятия, то ему могут быть доступны только его собственные входящие, исходящие и производственные сертификаты.

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

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

  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

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

Объект getVetDocumentByUuidRequest

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

Поле Описание Тип Обязательность
localTransactionId Идентификатор заявки в клиентской системе. xs:NCName 1
initiator Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт. argc:User 1
UUID Идентификатор ВСД. bs:UUID 1
enterpriseGuid Идентификатор предприятия, для которого запрошен ВСД. bs:UUID 1 - обязателен для ХС. При запросе от ВУ не требуется.

Объект ..Request/initiator

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

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

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

Объект getVetDocumentByUuidResponse

Объект содержит сведения о результатах обработки запроса на получение сведений о ВСД по его идентификатору.

Поле Описание Тип Обязательность
vetDocument Сведения о ВСД. argc:User 1

Объект ..Response/vetDocument

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

Поле Описание Тип Обязательность
UUID Идентификатор ВСД. bs:UUID 1
issueSeries Серия ВСД. Указывается для документа, оформленного на бланке строгой отчётности. bs:String255 0..1
issueNumber Номер ВСД. Указывается для документа, оформленного на бланке строгой отчётности. bs:String255 0..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
broker Сведения о фирме-посреднике (перевозчике продукции). ent:BusinessEntity 0..1
transportInfo Сведения о транспорте. shp:TransportInfo 0..1
transportStorageType Способ хранения продукции при перевозке. shp:TransportationStorageType 0..1
cargoReloadingPointList Сведения о маршруте следования (пунктах перегрузки). shp:ShipmentRoute 0..1
waybillSeries Серия товарно-транспортной накладной. bs:String255 0..1
waybillNumber Номер товарно-транспортной накладной. bs:String255 0..1
waybillDate Дата товарно-транспортной накладной. xs:date 0..1
cargoExpertized Проводилась ли ветсанэкспертиза.
  • Для типа продукции "Живые животные" поле отсутствует.
 xs:boolean 0..1
expertiseInfo Результаты лабораторных исследований.
  • Для типа продукции "Живые животные" поле отсутствует.
 bs:String255 0..1
confirmedBy Государственный ветврач, выдавший ВСД. argc:User 1
locationProsperity Благополучие местности. bs:String255 1
transferPermit Сведения о ветеринарном разрешении управления ветеринарии субъекта РФ на перемещение продукции в другой субъект. argc:Document 0..1
specialMarks Особые отметки. bs:String255 0..1

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

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

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

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

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

Элемент может не указываться. В этом случае значение по-умолчанию устанавливается 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 0..1
GUID Глобальный идентификатор номенклатуры производителя. bs:UUID 0..1
name Наименование продукции в соответствии с номенклатурой производителя. bs:String255 1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Поле Описание Тип Обязательность
producer Производитель продукции. vetd:Producer 1

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

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

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

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

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

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

Объект ..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/broker

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

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

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

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

Поле Описание Тип Обязательность
transportType Тип транспортного средства. shp:TransportType 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/cargoReloadingPointList/cargoReloadingPoint/nextTransport/transportNumber

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

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

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

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

Поле Описание Тип Обязательность
fio ФИО врача, оформившего ветеринарно-сопроводительный документ. bs:String255 1
post Должность врача, оформившего ветеринарно-сопроводительный документ. bs:String255 1

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

Сведения о ветеринарном разрешении управления ветеринарии субъекта РФ на перемещение продукции в другой субъект.

Поле Описание Тип Обязательность
name Название документа. bs:String255 0..1
form Форма документа. bs:String255 0..1
issueSeries Серия документа. bs:String255 0..1
issueNumber Номер документа. bs:String255 0..1
issueDate Дата документа. xs:date 0..1

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

Пример запроса - для ветеринарного управления

<codeblock language="xml" class="mw-collapsible> <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:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                 xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
  <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>2015-01-10T17:03:00</app:issueDate>
           <app:data>
              <mercvu:getVetDocumentByUuidRequest>
                 <mercvu:localTransactionId>a10003</mercvu:localTransactionId>
                 <mercvu:initiator>
                    <com:login>user</com:login>
                 </mercvu:initiator>
                 <base:uuid>vetDocumentId</base:uuid>
              </mercvu:getVetDocumentByUuidRequest>
           </app:data>
        </app:application>
     </ws:submitApplicationRequest>
  </soapenv:Body>

</soapenv:Envelope> </syntaxhighlight>


Пример запроса - для хозяйствующего субъекта

<codeblock language="xml" class="mw-collapsible> <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:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                 xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
  <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-01-10T17:03:00</app:issueDate>
           <app:data>
              <merc:getVetDocumentByUuidRequest>
                 <merc:localTransactionId>a10003</merc:localTransactionId>
                 <merc:initiator>
                    <com:login>user</com:login>
                 </merc:initiator>
                 <base:uuid>vetDocumentId</base:uuid>
                 <ent:enterpriseGuid>guid</ent:enterpriseGuid>
              </merc:getVetDocumentByUuidRequest>
           </app:data>
        </app:application>
     </ws:submitApplicationRequest>
  </soapenv:Body>

</soapenv:Envelope> </syntaxhighlight>

Коды ошибок

В таблице ниже приведены коды ошибок, возвращаемые веб-сервисом при различных несоответствиях формату или бизнес-правилам.

Код Описание ошибки
MERC29180 Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC29224 Ветеринарно-сопроводительный документ не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.

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

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