GetVetDocumentByUuidOperationForVetControl
Общие сведения
Операция GetVetDocumentByUuidOperationForVetControl предназначена для получения ветеринарно-сопроводительного документа (ВСД) по его уникальному идентификатору. На вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- идентификатор ВСД.
Результатом выполнения данной операции является:
- пользователю передаются сведения о запрашиваемом ВСД.
Запрашиваться могут только те ВСД, которые ветеринарное управление инициатор оформило.
Возможные сценарии
При обработке запроса возможны следующие сценарии:
- Запрос успешно обработан.
- Произошла ошибка при обработке запроса.
- Некорректный запрос.
- Внутренняя ошибка системы.
Используемые пространства имён и типы
|
|
Данные запроса
Структура данных запроса в формате ХML.
<mercvu:getVetDocumentByUuidRequest 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:shp="http://api.vetrf.ru/schema/cdm/argus/shipment"
xmlns:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<mercvu:localTransactionId>{xs:NCName}</mercvu:localTransactionId>
<mercvu:initiator>
<base:uuid>{bs:UUID}</base:uuid>
<com:login>{xs:NCName}</com:login>
</mercvu:initiator>
<base:uuid>{bs:UUID}</base:uuid>
<ent:businessMember>
<ent:businessEntity>
<base:guid>{bs:UUID}</base:guid>
</ent:businessEntity>
<ent:enterprise>
<base:guid>{bs:UUID}</base:guid>
</ent:enterprise>
</ent:businessMember>
</mercvu:getVetDocumentByUuidRequest>
Объект getVetDocumentByUuidRequest
Корневой элемент содержимого заявки на получение ВСД по идентификатору.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| localTransactionId | Идентификатор заявки в клиентской системе. | xs:NCName | 1 |
| initiator | Пользователь, инициирующий запрос к шлюзу. Ответственный за выполнение бизнес-операции. Должен быть указан или идентификатор, или логин. | argc:User | 1 |
| UUID | Идентификатор ВСД. | bs:UUID | 1 |
| businessMember | Хозсубъект и предприятие, по которым производится поиск | bs:UUID | 0..1 |
Объект ..Request/initiator
Объект содержит сведения о пользователе, инициирующем запрос к шлюзу.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| UUID | Идентификатор пользователя, зарегистрированного в системе Меркурий. | bs:UUID | 0..1 |
| login | Логин пользователя. Авторизация проводится по одному из параметров. Если указаны оба. то приоритет за UUID. | xs:NCName | 0..1 |
Объект ..Request/businessMember
Объект содержит сведения о хозяйствующем субъекте, для которого запрашивается список ветеринарных сертификатов.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| businessEntity | Сведения о хозяйствующем субъекте, для которого запрашивается список ВСД. | ent:BusinessEntity | 0..1 |
| enterprise | Сведения о предприятии, для которого запрашивается список ветеринарных сертификатов. | xs:nonNegativeInteger | 0..1 |
Объект ..Request/businessMember/businessEntity
Объект описывает хозяйствующий субъект, для которого производится отбор записей складского журнала.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| UUID | Идентификатор версии записи хозяйствующего субъекта | bs:UUID | 0..1 |
| GUID | Глобальный идентификатор хозяйствующего субъекта в реестре РСХН | bs:UUID | 0..1 |
Объект ..Request/businessMember/enterprise
Объект описывает предприятия, для которого производится отбор записей складского журнала.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| UUID | Идентификатор версии записи хозяйствующего субъекта | bs:UUID | 0..1 |
| GUID | Глобальный идентификатор хозяйствующего субъекта в реестре РСХН | bs:UUID | 0..1 |
Данные ответа
Структура данных ответа в формате ХML.
<getVetDocumentByUuidResponse xmlns="http://api.vetrf.ru/schema/cdm/mercury/applications">
<vetDocument xmlns="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<vetd:issueSeries xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{bs:String255}</vetd:issueSeries>
<vetd:issueNumber xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{bs:String255}</vetd:issueNumber>
<vetd:issueDate xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{xs:date}</vetd:issueDate>
<vetd:form xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{vetd:VetDocumentForm}</vetd:form>
<vetd:type xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{vetd:VetDocumentType}</vetd:type>
<vetd:status xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{vetd:VetDocumentStatus}</vetd:status>
<vetd:consignor xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<ent:businessEntity xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</ent:businessEntity>
<ent:enterprise xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</ent:enterprise>
</vetd:consignor>
<vetd:consignee xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<ent:businessEntity xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</ent:businessEntity>
<ent:enterprise xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</ent:enterprise>
</vetd:consignee>
<vetd:batch xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<vetd:productType>{argpr:ProductType}</vetd:productType>
<vetd:product>
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:product>
<vetd:subProduct>
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:subProduct>
<vetd:productItem>
<prod:name xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production">{bs:String255}
</prod:name>
</vetd:productItem>
<vetd:volume>{bs:Decimal}</vetd:volume>
<vetd:unit>
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:unit>
<vetd:packingList>
<argc:packingForm xmlns:argc="http://api.vetrf.ru/schema/cdm/argus/common">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}
</bs:uuid>
<argc:name>{bs:String255}</argc:name>
</argc:packingForm>
</vetd:packingList>
<vetd:packingAmount>{xs:int}</vetd:packingAmount>
<vetd:dateOfProduction>
<vetd:firstDate>
<bs:year xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Year}</bs:year>
<bs:month xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Month}</bs:month>
<bs:day xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Day}</bs:day>
<bs:hour xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bsHour}</bs:hour>
</vetd:firstDate>
<vetd:secondDate>
<bs:year xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Year}</bs:year>
<bs:month xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Month}</bs:month>
<bs:day xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Day}</bs:day>
<bs:hour xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bsHour}</bs:hour>
</vetd:secondDate>
</vetd:dateOfProduction>
<vetd:expiryDate>
<vetd:firstDate>
<bs:year xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Year}</bs:year>
<bs:month xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Month}</bs:month>
<bs:day xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Day}</bs:day>
<bs:hour xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bsHour}</bs:hour>
</vetd:firstDate>
<vetd:secondDate>
<bs:year xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Year}</bs:year>
<bs:month xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Month}</bs:month>
<bs:day xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:Day}</bs:day>
<bs:hour xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bsHour}</bs:hour>
</vetd:secondDate>
</vetd:expiryDate>
<vetd:perishable>{xs:boolean}</vetd:perishable>
<vetd:countryOfOrigin>
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:countryOfOrigin>
<vetd:producerList>
<ent:producer xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
<ent:enterprise>
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}
</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}
</bs:guid>
</ent:enterprise>
<ent:role>{ent:EnterpriseRole}</ent:role>
</ent:producer>
</vetd:producerList>
<vetd:productMarkingList>
<vetd:productMarking>{bs:String255}</vetd:productMarking>
</vetd:productMarkingList>
<vetd:lowGradeCargo>{xs:boolean}</vetd:lowGradeCargo>
<vetd:owner>
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:owner>
</vetd:batch>
<vetd:purpose xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:purpose>
<vetd:broker xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<bs:uuid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:uuid>
<bs:guid xmlns:bs="http://api.vetrf.ru/schema/cdm/base">{bs:UUID}</bs:guid>
</vetd:broker>
<vetd:transportInfo xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<shp:transportType xmlns:shp="http://api.vetrf.ru/schema/cdm/argus/shipment">{shp:TransportType}</shp:transportType>
<shp:transportNumber xmlns:shp="http://api.vetrf.ru/schema/cdm/argus/shipment">
<shp:vehicleNumber>{bs:String255}</shp:vehicleNumber>
</shp:transportNumber>
</vetd:transportInfo>
<vetd:transportStorageType xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{shp:TransportationStorageType}
</vetd:transportStorageType>
<vetd:cargoReloadingPointList xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<shp:cargoReloadingPoint xmlns:shp="http://api.vetrf.ru/schema/cdm/argus/shipment">
<shp:name>{bs:String255}</shp:name>
<shp:nextTransport>
<shp:transportType>{shp:TransportType}</shp:transportType>
<shp:transportNumber>
<shp:vehicleNumber>{bs:String255}</shp:vehicleNumber>
</shp:transportNumber>
</shp:nextTransport>
</shp:cargoReloadingPoint>
</vetd:cargoReloadingPointList>
<vetd:waybillNumber xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{bs:String255}</vetd:waybillNumber>
<vetd:waybillDate xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{xs:date}</vetd:waybillDate>
<vetd:cargoExpertized xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{xs:boolean}
</vetd:cargoExpertized>
<vetd:expertiseInfo xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{bs:String255}
</vetd:expertiseInfo>
<vetd:confirmedBy xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<argc:fio xmlns:argc="http://api.vetrf.ru/schema/cdm/argus/common">{bs:String255}</argc:fio>
<argc:post xmlns:argc="http://api.vetrf.ru/schema/cdm/argus/common">{bs:String255}</argc:post>
</vetd:confirmedBy>
<vetd:locationProsperity xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{bs:String255}
</vetd:locationProsperity>
<vetd:transferPermit xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">
<argc:issueNumber xmlns:argc="http://api.vetrf.ru/schema/cdm/argus/common">{bs:String255}</argc:issueNumber>
<argc:issueDate xmlns:argc="http://api.vetrf.ru/schema/cdm/argus/common">{xs:date}</argc:issueDate>
</vetd:transferPermit>
<vetd:specialMarks xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document">{bs:String255}
</vetd:specialMarks>
</vetDocument>
</getVetDocumentByUuidResponse>Объект getVetDocumentByUuidResponse
Объект содержит сведения о результатах обработки запроса на получение сведений о ВСД по его идентификатору.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| vetDocument | Сведения о ВСД. | argc:User | 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 |
| broker | Сведения о фирме-посреднике (перевозчике продукции). | ent:BusinessEntity | 0..1 |
| transportInfo | Сведения о транспорте. | shp:TransportInfo | 0..1 |
| transportStorageType | Способ хранения продукции при перевозке. | shp:TransportationStorageType | 0..1 |
| cargoReloadingPointList | Сведения о маршруте следования (пунктах перегрузки). | shp:ShipmentRoute | 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 | 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 | 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 | Является ли продукция качественной. | 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
Объект содержит сведения о наименовании продукции.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| 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
Сведения о ветеринарном разрешении управления ветеринарии субъекта РФ на перемещение продукции в другой субъект.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| issueNumber | ФИО врача, оформившего ветеринарно-сопроводительный документ. | bs:String255 | 1 |
| issueDate | Должность врача, оформившего ветеринарно-сопроводительный документ. | xs:date | 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> <ent:businessMember> <ent:businessEntity> <base:guid>guid</base:guid> </ent:businessEntity> <ent:enterprise> <base:guid>guid</base:guid> </ent:enterprise> </ent:businessMember> </mercvu:getVetDocumentByUuidRequest> </app:data> </app:application> </ws:submitApplicationRequest> </soapenv:Body>
</soapenv:Envelope> </syntaxhighlight>
Коды ошибок
В таблице ниже приведены коды ошибок, возвращаемые веб-сервисом при различных несоответствиях формату или бизнес-правилам.
| Код | Описание ошибки |
|---|---|
| MERC29180 | Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату. |
| MERC29224 | Ветеринарно-сопроводительный документ не найден в реестре РСХН, либо идентификатор не соответствует установленному формату. |