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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 154: Строка 154:
|-
|-
| '''vetDocumentStatus''' || Статус ВСД:
| '''vetDocumentStatus''' || Статус ВСД:
* создан (CREATED);
<!-- * создан (CREATED); -->
* подтверждён (CONFIRMED);
* подтверждён (CONFIRMED);
* аннулирован (WITHDRAWN);
* аннулирован (WITHDRAWN);

Версия 09:49, 22 июня 2016


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

Операция GetVetDocumentListOperation предназначена для получения всех ветеринарно-сопроводительных документов предприятия. При этом список ВСД может быть отфильтрован по следующим критериям:

  • Тип ВСД:
    • входящий ВСД;
    • исходящий ВСД;
    • производственный ВСД;
    • транспортный ВСД;
    • возвратный ВСД.
  • Статус ВСД:
    • оформлен;
    • погашен;
    • аннулирован.

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

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

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

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

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

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

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

  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

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

Объект getVetDocumentListRequest

Корневой элемент содержимого заявки на получение всех ветеринарно-сопроводительных документов предприятия.

Поле Описание Тип Обязательность
localTransactionId Идентификатор заявки в клиентской системе. xs:NCName 1
initiator Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт. argc:User 1
listOptions Параметры запрашиваемого списка. bs:ListOptions 0..1
vetDocumentType Тип ВСД:
  • входящий (INCOMING);
  • исходящий (OUTGOING);
  • производственный (PRODUCTIVE)
 vetd:VetDocumentType 0..1
vetDocumentStatus Статус ВСД:
  • подтверждён (CONFIRMED);
  • аннулирован (WITHDRAWN);
  • погашен (UTILIZED)
 vetd:VetDocumentStatus 0..1
businessMember Идентификаторы предприятия и ХС, по которым производится поиск ВСД. ent:BusinessMember 1 - при запросе от имени ветеринарного управления необходимо указывать businessMember; при запросе от имени ХС по-прежнему указывается enterpriseGuid.
enterpriseGuid Идентификатор предприятия, по которому производится поиск ВСД. bs:UUID

Объект ..Request/initiator

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

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

Объект ..Request/listOptions

Объект содержит сведения о параметрах запрашиваемого списка ВСД.

Поле Описание Тип Обязательность
count Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
 xs:nonNegativeInteger 0..1
offset Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
 xs:nonNegativeInteger 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

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

Объект getVetDocumentListResponse

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

Поле Описание Тип Обязательность
vetDocumentList Список ВСД. vetd:VetDocumentList 1

Объект ..Response/vetDocumentList

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

Поле Описание Тип Обязательность
vetDocument ветеринарно-сопроводительный документ. vetd:VetDocument 1

Объект ..Response/vetDocumentList/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
waybillNumber Номер товарно-транспортной накладной. vetd:Batch 0..1
waybillDate Дата товарно-транспортной накладной. vetd:Batch 0..1
cargoExpertized Проводилась ли ветсанэкспертиза.
  • Для типа продукции "Живые животное" поле отсутствует.
 xs:boolean 0..1
confirmedBy Государственный ветврач, подписавший ВСД. argc:User 1
locationProsperity Благополучие местности. bs:String255 1
specialMarks Особые отметки. bs:String255 0..1

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

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

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

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

Объект содержит сведения о хозяйствующем субъекте.

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

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

Объект содержит сведения о площадке (поднадзорном объекте).

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

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

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

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

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

Объект содержит сведения о хозяйствующем субъекте.

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

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

Объект содержит сведения о площадке (поднадзорном объекте).

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

Объект ..Response/vetDocumentList/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/vetDocumentList/vetDocument/batch/product

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

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

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

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

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

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

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

Поле Описание Тип Обязательность
name Наименование продукции в соответствии с номенклатурой производителя xs:string 1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Объект ..Response/vetDocumentList/vetDocument/broker

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

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

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

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

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

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

Сведения о номере транспортного средства.

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

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

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

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

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

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

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

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

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

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

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

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

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

Коды ошибок

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

Код ошибки Описание
MERC31180 Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC31270 Указана фильтрация ветеринарно-сопроводительных документов по состоянию "создан".

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

Пример запроса всех исходящих аннулированных ВСД предприятия от имени ветеринарного управления. 

<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:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
                  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:getVetDocumentListRequest>
                      <mercvu:localTransactionId>a10003</mercvu:localTransactionId>
                      <mercvu:initiator>
                          <com:login>mercury_user</com:login>
                      </mercvu:initiator>
                      <base:listOptions>
	                  <base:count>10</base:count>
	                  <base:offset>0</base:offset>
	              </base:listOptions>
                      <vet:vetDocumentType>OUTGOING</vet:vetDocumentType>
                      <vet:vetDocumentStatus>WITHDRAWN</vet:vetDocumentStatus>
	              <ent:businessMember>
                          <ent:businessEntity>
                               <bs:guid>guid</guid>
                          </ent:businessEntity>
                          <ent:enterprise>
                               <bs:guid>guid</guid>
                          </ent:enteprise>
                      </ent:businessMember>
                 </mercvu:getVetDocumentListRequest>
            </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:vet="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
                  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:getVetDocumentListRequest>
                  <merc:localTransactionId>a10003</merc:localTransactionId>
                  <merc:initiator>
                      <com:login>egorova-iv-150707</com:login>
                  </merc:initiator>
                  <base:listOptions>
	               	<base:count>10</base:count>
	               	<base:offset>0</base:offset>
	          </base:listOptions>
                  <vet:vetDocumentType>INCOMING</vet:vetDocumentType>
                  <vet:vetDocumentStatus>UTILIZED</vet:vetDocumentStatus>
	          <ent:enterpriseGuid>guid</ent:enterpriseGuid>
               </merc:getVetDocumentListRequest>
            </app:data>
         </app:application>
      </ws:submitApplicationRequest>
   </soapenv:Body>
</soapenv:Envelope>

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

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