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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Egorova-iv-150707 переименовал страницу GetStockEntryByGuidOperation в GetStockEntryByGuidOperation v1.2)
 
 
(не показано 8 промежуточных версий 2 участников)
Строка 1: Строка 1:
#перенаправление [[GetStockEntryByGuidOperation v1.2]]
<!--- #перенаправление [[GetStockEntryByGuidOperation v1.2]] -->
== Общие сведения ==
Операция '''GetStockEntryByGuidOperation''' предназначена для получения последней (актуальной) версии записи складского журнала продукции по ее глобальному идентификатору. Складской журнал продукции в системе Меркурий ведется с применением версионирования, это означает, что при каждом изменении записи складского журнала создается новая версия этой записи.
* GUID - глобальный идентификатор записи складского журнала. Данный идентификатор остается неизменным для всех версий записи складского журнала.
* UUID - идентификатор версии записи складского журнала. Данный идентификатор изменяется для каждой новой версии записи складского журнала.
Так же следует различать актуальную и неактуальную версию записи складского журнала. Для одной записи журнала может существовать только одна актуальная версия.
 
При выполнении операции '''GetStockEntryByGuidOperation''' на вход системы передаются следующие сведения:
* информация о пользователе - инициаторе запроса;
* глобальный идентификатор записи складского журнала.
Результатом выполнения данной операции является:
* пользователю передаются сведения о запрашиваемой версии записи складского журнала.
 
Запрашиваться могут только те записи складского журнала продукции, где хозяйствующий-субъект инициатор запроса является владельцем продукции.
 
=== Возможные сценарии ===
При обработке запроса возможны следующие сценарии:
# Запрос успешно обработан.<br />
# Произошла ошибка при обработке запроса.
::* Некорректный запрос.
::* Внутренняя ошибка системы.
 
===Используемые пространства имён и типы===
{{столбцы}}
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/common|argc]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/common</nowiki>)
** [[PackingFormList|argc:PackingFormList]]
** [[Unit|argc:Unit]]
** [[User|argc:User]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/production|argpr]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/production</nowiki>)
** [[Product|argpr:Product]]
** [[ProductItem|argpr:ProductItem]]
** [[ProductType|argpr:ProductType]]
** [[SubProduct|argpr:SubProduct]]
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[Decimal|bs:Decimal]]
** [[String255|bs:String255]]
** [[UUID|bs:UUID]]
** [[VersionStatus|bs:VersionStatus]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/cerberus/enterprise|ent]] (<nowiki>http://api.vetrf.ru/schema/cdm/cerberus/enterprise</nowiki>)
** [[BusinessEntity|ent:BusinessEntity]]
** [[Enterprise|ent:Enterprise]]
** [[BusinessMember|ent:BusinessMember]]
** [[EnterpriseRole|ent:EnterpriseRole]]
** [[ProducerList|ent:ProducerList]]
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
** [[Country|ikar:Country]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/mercury/vet-document|vetd]] (<nowiki>http://api.vetrf.ru/schema/cdm/mercury/vet-document</nowiki>)
** [[Batch|vetd:Batch]]
** [[GoodsDate|vetd:GoodsDate]]
** [[PackingForm|vetd:PackingForm]]
** [[ProductMarkingList|vetd:ProductMarkingList]]
** [[Producer|vetd:Producer]]
** [[VetDocument|vetd:VetDocument]]
** [[StockEntry|vetd:StockEntry]]
** [[StockEntryNumber|vetd:StockEntryNumber]]
{{столбец}}
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:date]
**  [http://www.w3.org/TR/xmlschema-2/#int xs:int]
** [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбцы/конец}}
 
===Общие отличия между версией для хозяйствующих субъектов и ветеринарных управлений ===
 
{| 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">
<mercvu:getStockEntryByGuidRequest 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">                     
    <mercvu:localTransactionId>{xs:NCName}</mercvu:localTransactionId>
    <mercvu:initiator>
        <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:getStockEntryByUuidRequest>     
</syntaxhighlight>
</div>
</div> -->
 
===Объект getStockEntryByGuidRequest ===
Корневой элемент содержимого заявки на получение версии записи складского журнала продукции по идентификатору.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''localTransactionId''' || Идентификатор заявки в клиентской системе. || [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName] || 1
|-
| [[#Объект ..Request/initiator|'''initiator''']] || Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт. || [[User|argc:User]] || 1
|-
| '''GUID''' || Идентификатор версии записи складского журнала. || [[UUID|bs:UUID]] || 1
|-
| [[#Объект ..Request/businessMember|'''businessMember''']] || Обслуживаемые ХС и предприятие, по которым производится поиск записей. || [[BusinessMember|ent:BusinessMember]] || rowspan="2" | 1 - при запросе от имени хозяйствующего субъекта по-прежнему достаточно enterpriseGuid; при запросе из ИС ветеринарного управления нуобходимо указывать businessMember.
|-
| '''enterpriseGuid''' || Предприятие, по которому производится поиск записей. || [[UUID|bs:UUID]]
|}
 
=== Объект [[#Объект getStockEntryByGuidRequest|..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]
|}
 
 
=== Объект [[#Объект getStockEntryByGuidRequest|..Request]]/'''businessMember'''===
Объект содержит сведения о параметрах запрашиваемого списка записей складского журнала.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Request/businessMember/businessEntity|'''businessEntity''']] || Хозяйствующий субъект, для которого производится поиск записей складского журнала || [[BusinessEntity|ent:BusinessEntity]] || 0..1
|-
| [[#Объект ..Request/businessMember/enterprise|'''enterprise''']] || Предприятие, для которого осуществляется отбор записей складского журнала || [[Enterprise|ent:Enterprise]]  || 0..1
|}
 
=== Объект [[#Объект getStockEntryByGuidRequest|..Request]]/[[#Объект ..Request/businessMember|businessMember]]/'''businessEntity'''===
 
Объект описывает хозяйствующий субъект, для которого производится отбор записей складского журнала.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи хозяйствующего субъекта || [[UUID|bs:UUID]] || 0..1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре РСХН || [[UUID|bs:UUID]] || 0..1
|}
 
=== Объект [[#Объект getStockEntryByGuidRequest|..Request]]/[[#Объект ..Request/businessMember|businessMember]]/'''enterprise'''===
 
Объект описывает предприятие, для которого производится отбор записей складского журнала.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи предприятия || [[UUID|bs:UUID]] || 0..1
|-
| '''GUID''' || Глобальный идентификатор предприятия в реестре РСХН || [[UUID|bs:UUID]] || 0..1
|}
 
== Данные ответа ==
<!--
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<mercvu:getStockEntryByGuidResponse xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/applications"
                            xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                            xmlns:vetd="http://api.vetrf.ru/schema/cdm/mercury/vet-document"
                            xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production"
                            xmlns:argc="http://api.vetrf.ru/schema/cdm/argus/common"
                            xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
    <vetd:stockEntry>
        <bs:uuid>{bs:UUID}</bs:uuid>
        <bs:guid>{bs:UUID}</bs:guid>
        <bs:active>{xs:boolean}</bs:active>
        <bs:last>{xs:boolean}</bs:last>
        <bs:status>{bs:VersionStatus}</bs:status>
        <bs:createDate>{xs:dateTime}</bs:createDate>
        <bs:updateDate>{xs:dateTime}</bs:updateDate>
        <bs:previous>{bs:UUID}</bs:previous>
        <bs:next>{bs:UUID}</bs:next>
        <ent:entryNumber>{xs:string}</ent:entryNumber>
        <vetd:batch>
            <vetd:productType>{argpr:ProductType}</vetd:productType>
    <vetd:product>
        <bs:uuid>{bs:UUID}</bs:uuid>
        <bs:guid>{bs:UUID}</bs:guid>
    </vetd:product>
    <vetd:subProduct>
        <bs:uuid>{bs:UUID}</bs:uuid>
        <bs:guid>{bs:UUID}</bs:guid>
    </vetd:subProduct>
    <vetd:productItem>
        <prod:name>{bs:String255}</prod:name>
    </vetd:productItem>
    <vetd:volume>{bs:Decimal}</vetd:volume>
    <vetd:unit>
        <bs:uuid>{bs:UUID}</bs:uuid>
        <bs:guid>{bs:UUID}</bs:guid>
    </vetd:unit>
    <vetd:packingList>
        <argc:packingForm>
            <bs:uuid>{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>{bs:Year}</bs:year>
    <bs:month>{bs:Month}</bs:month>
    <bs:day>{bs:Month}</bs:day>
        </vetd:firstDate>
    </vetd:dateOfProduction>
    <vetd:expiryDate>
        <vetd:firstDate>
            <bs:year>{bs:Year}</bs:year>
    <bs:month>{bs:Month}</bs:month>
    <bs:day>{bs:Month}</bs:day>
        </vetd:firstDate>
    </vetd:expiryDate>
    <vetd:perishable>{xs:boolean}</vetd:perishable>
    <vetd:countryOfOrigin>
        <bs:uuid>{bs:UUID}</bs:uuid>
        <bs:guid>{bs:UUID}</bs:guid>
    </vetd:countryOfOrigin>
    <vetd:producerList>
        <ent:producer>
            <ent:enterprise>
        <bs:uuid>{bs:UUID}</bs:uuid>
        <bs:guid>{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>{bs:UUID}</bs:uuid>
        <bs:guid>{bs:UUID}</bs:guid>
            </vetd:owner>
        </vetd:batch>
    </vetd:stockEntry>
</mercvu:getStockEntryByUuidResponse>
</syntaxhighlight>
</div>
</div>
-->
===Объект getStockEntryByUuidResponse===
Объект содержит результат обработки запроса на получение версии записи складского журнала по идентификатору.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
|[[#Объект ..Response/stockEntry |'''stockEntry''']]|| Запись складского журнала продукции.|| [[StockEntry|vetd:StockEntry]] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/'''stockEntry'''===
Объект содержит сведения о записи складского журнала продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
|'''UUID'''|| Идентификатор версии записи  журнала.|| [[UUID|bs:UUID]] || 1
|-
| '''GUID'''|| Глобальный идентификатор записи журнала. || [[UUID|bs:UUID]] || 1
|-
| '''active'''|| Является ли запись журнала активной:
* true - запись активна;
* false - запись не активна.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
|'''last'''|| Последняя версия записи журнала:
* true - да;
* false - нет.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''status'''|| Статус версии записи журнала. || [[VersionStatus|bs:VersionStatus]] || 1
|-
|'''createDate'''|| Дата создания записи журнала. || [http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] || 1
|-
|'''updateDate'''|| Дата изменения записи журнала. || [http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] || 1
|-
|'''previous'''|| Идентификатор предыдущей версии записи журнала. || [[UUID|bs:UUID]]  || 0..1
|-
|'''next'''|| Идентификатор следующей версии записи журнала. || [[UUID|bs:UUID]]  || 0..1
|-
|'''entryNumber'''|| Номер записи журнала, доступный через веб-интерфейс. || [http://www.w3.org/TR/xmlschema-2/#string|xs:string]  || 0..1
|-
| [[#Объект ..Response/stockEntry/batch|'''batch''']]|| Сведения о партии продукции.  || [[Batch|vetd:Batch]] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/'''batch'''===
Объект содержит сведения о партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
|'''productType'''|| Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий.  || [[ProductType|argpr:ProductType]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/product|'''product''']]|| Продукция. Второй уровень иерархического справочника продукции ИС Меркурий.  || [[Product|argpr:Product]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/subProduct|'''subProduct''']]||Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.  || [[SubProduct|argpr:SubProduct]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/productItem|'''productItem''']]||Наименование продукции в номенклатуре производителя. || [[ProductItem|argpr:ProductItem]] || 0..1
|-
| '''volume'''|| Объем продукции.
* Значение должно быть больше нуля.
|| [[Decimal|bs:Decimal]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/unit|'''unit''']]|| Единица измерения объема партии продукции. || [[Unitl|argc:Unit]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/packingList|'''packingList''']]|| Список видов упаковки.  || [[PackingFormList|argc:PackingFormList]] || 0..1
|-
| '''packingAmount'''||  Общее количество единиц упаковки. || [http://www.w3.org/TR/xmlschema-2/#int xs:int] || 0..1
|-
| '''dateOfProduction'''|| Дата выработки продукции. Может быть указана тремя способами: датой, диапазоном дат, строкой. В случае точной даты выработки указывается только первая компонента - firstDate.|| [[GoodsDate|vetd:GoodsDate]] || 1
|-
|'''expiryDate'''|| Дата окончания срока годности продукции. Может быть указана тремя способами: датой, диапазоном дат, строкой. В случае точной даты выработки указывается только первая компонента - firstDate.  || [[GoodsDate|vetd:GoodsDate]] || 1
|-
| '''perishable'''|| Описывает, является ли продукция скоропортящейся:
* true – скоропортящаяся;
* false – не скоропортящаяся.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| [[#Объект ..Response/stockEntry/batch/countryOfOrigin |'''countryOfOrigin''']] || Страна происхождения партии продукции. ||[[Country|ikar:Country]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/producerList | '''producerList''']] || Список производителей продукции.|| [[ProducerList|ent:ProducerList]] || 1
|-
| [[#Объект ..Response/stockEntry/batch/productMarkingList | '''productMarkingList''']] ||  Список маркировки, доступный для данного производителя.|| [[ProductMarkingList|vetd:ProductMarkingList]] || 0..1
|-
|'''lowGradeCargo'''|| Является ли груз некачественным.
*true – груз некачественный;
*false – груз качественный.
Элемент может не указываться. В этом случае значение по-умолчанию устанавливается false.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| [[#Объект ..Response/stockEntry/batch/owner | '''owner''' ]] ||  Хозяйствующий субъект - владелец продукции.  || [[businessEntity|ent:BusinessEntity]] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''product'''===
Объект содержит сведения о продукции; второй уровень иерархического справочника продукции ИС Меркурий.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии продукции.|| [[UUID|bs:UUID]] ||1
|-
| '''GUID''' || Глобальный идентификатор продукции.|| [[UUID|bs:UUID]]||1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''subProduct'''===
Объект содержит сведения о видах продукции; третий уровень иерархического справочника продукции ИС Меркурий.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии вида продукции. || [[UUID|bs:UUID]] ||1
|-
| '''GUID''' || Глобальный идентификатор продукции. || [[UUID|bs:UUID]] ||1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/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]
|}
 
===Объект [[#Объект getStockEntryByUuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''unit'''===
Объект содержит сведения о единице измерения объема партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии единицы измерения. || [[UUID|bs:UUID]] ||1
|-
| '''GUID''' || Глобальный идентификатор единицы измерения. || [[UUID|bs:UUID]] ||1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''packingList'''===
Объект содержит сведения о списке видов упаковки, которые используются для партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/stockEntry/batch/stockEntry/packingList/packingForm|'''packingForm''']] || Вид упаковки. || [[PackingForm|vetd:PackingForm]] || 0..*
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/[[#Объект ..Response/stockEntry/batch/packingList|packingList]]/'''packingForm'''===
Объект содержит сведения о виде упаковки, которая используются для партии продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор упаковки. || [[UUID|bs:UUID]] || 1
|-
| '''name''' || Наименование конкретного вида упаковки. || [http://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''countryOfOrigin'''===
Объект содержит сведения о стране-происхождения продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии страны происхождения. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор страны происхождения. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''producerList'''===
Объект содержит сведения о списке производителей продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/stockEntry/batch/producerList/producer|'''producer''' ]] || Производитель продукции.|| [[Producer|vetd:Producer]]  || 0..*
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/[[#Объект ..Response/stockEntry/batch/producerList|producerList]]/'''producer'''===
Объект содержит сведения о производителе продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/stockEntry/batch/producerList/producer/enterprise | '''enterprise''']] || Информация о предприятие-производителе продукции.|| [[Enterprise|ent:Enterprise]] || 1
|-
| '''role''' ||Роль предприятия-производителя продукции.||  [[EnterpriseRole|ent:EnterpriseRole]] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/[[#Объект ..Response/stockEntry/batch/producerList|producerList]]/[[#Объект ..Response/stockEntry/batch/producerList/producer|producer]]/'''enterprise'''===
Объект содержит сведение о предприятие-производителе продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии  предприятия-производителя продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор предприятия-производителя продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''productMarkingList'''===
Объект содержит сведения о списке маркировки.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''productMarking''' || Строка с маркировкой продукции. || [[String255|bs:String255]] || 0..*
|}
 
===Объект [[#Объект getStockEntryByGuidResponse|..Response]]/[[#Объект ..Response/stockEntry|stockEntry]]/[[#Объект ..Response/stockEntry/batch|batch]]/'''owner'''===
Объект содержит сведения о хозяйствующем субъекте-владельце продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии хозяйствующего субъекта - владельца продукции.|| [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта - владельца продукции.|| [[UUID|bs:UUID]] || 1
|}
 
==Примеры запросов==
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div >Получение записи складского журнала по её идентификатору - для версии ветеринарного управления</div>
<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: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:getStockEntryByGuidRequest>                     
                  <mercvu:localTransactionId>t2345</mercvu:localTransactionId>
                  <mercvu:initiator>
                      <com:login>a13</com:login>
                  </mercvu:initiator>
                  <base:guid>GUID</base:guid>
                  <mercvu:businessMember>
                      <ent:businessEntity>
                          <base:guid>guid</base:guid>
                      </ent:businessEntity>
                      <ent:enterprise>
                          <base:guid>guid</base:guid>
                      </ent:enterprise>
                  </mercvu:businessMember>
              </mercvu:getStockEntryByGuidRequest>
          </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 >Получение записи складского журнала по её идентификатору - для версии хозяйствующего субъекта</div>
<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: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:getStockEntryByGuidRequest>                     
                  <merc:localTransactionId>t2345</merc:localTransactionId>
                  <merc:initiator>
                      <com:login>a13</com:login>
                  </merc:initiator>
                  <base:guid>GUID</base:guid>
                  <ent:enterpriseGuid>guid</ent:enterpriseGuid>
              </merc:getStockEntryByGuidRequest>
          </app:data>
        </app:application>
      </ws:submitApplicationRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
 
==Коды ошибок==
 
В таблице содержатся коды ошибок, которые могут возникать при отправке неверных данных в приложение.
 
{| class="wikitable"
|-
! Код ошибки !! Описание
|-
| MERC34008 || Запись складского журнала продукции с указанным идентификатором не найдена в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC34180 || Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
|}
 
[[#top|Вернуться к началу &uarr;]]
[[Category:Ветис.API]]
[[Category:Складской журнал]]
[[Category:Ветис.API для ветеринарных управлений]]

Текущая версия на 11:29, 16 февраля 2017

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

Операция GetStockEntryByGuidOperation предназначена для получения последней (актуальной) версии записи складского журнала продукции по ее глобальному идентификатору. Складской журнал продукции в системе Меркурий ведется с применением версионирования, это означает, что при каждом изменении записи складского журнала создается новая версия этой записи.

  • GUID - глобальный идентификатор записи складского журнала. Данный идентификатор остается неизменным для всех версий записи складского журнала.
  • UUID - идентификатор версии записи складского журнала. Данный идентификатор изменяется для каждой новой версии записи складского журнала.

Так же следует различать актуальную и неактуальную версию записи складского журнала. Для одной записи журнала может существовать только одна актуальная версия.

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

  • информация о пользователе - инициаторе запроса;
  • глобальный идентификатор записи складского журнала.

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

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

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

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

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

  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

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

Объект getStockEntryByGuidRequest

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

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

Объект ..Request/initiator

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

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

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

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


Объект ..Request/businessMember

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

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

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

Объект getStockEntryByUuidResponse

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

Поле Описание Тип Обязательность
stockEntry Запись складского журнала продукции. vetd:StockEntry 1

Объект ..Response/stockEntry

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

Поле Описание Тип Обязательность
UUID Идентификатор версии записи журнала. bs:UUID 1
GUID Глобальный идентификатор записи журнала. bs:UUID 1
active Является ли запись журнала активной:
  • true - запись активна;
  • false - запись не активна.
 xs:boolean 1
last Последняя версия записи журнала:
  • true - да;
  • false - нет.
 xs:boolean 1
status Статус версии записи журнала. bs:VersionStatus 1
createDate Дата создания записи журнала. xs:DateTime 1
updateDate Дата изменения записи журнала. xs:DateTime 1
previous Идентификатор предыдущей версии записи журнала. bs:UUID 0..1
next Идентификатор следующей версии записи журнала. bs:UUID 0..1
entryNumber Номер записи журнала, доступный через веб-интерфейс. xs:string] 0..1
batch Сведения о партии продукции. vetd:Batch 1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Поле Описание Тип Обязательность
UUID Идентификатор версии хозяйствующего субъекта - владельца продукции. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта - владельца продукции. bs:UUID 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: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:getStockEntryByGuidRequest>                       
                   <mercvu:localTransactionId>t2345</mercvu:localTransactionId>
                   <mercvu:initiator>
                       <com:login>a13</com:login>
                   </mercvu:initiator>
                   <base:guid>GUID</base:guid>
                   <mercvu:businessMember>
                       <ent:businessEntity>
                           <base:guid>guid</base:guid>
                       </ent:businessEntity>
                       <ent:enterprise>
                           <base:guid>guid</base:guid>
                       </ent:enterprise>
                   </mercvu:businessMember>
              </mercvu:getStockEntryByGuidRequest> 
           </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:getStockEntryByGuidRequest>                       
                   <merc:localTransactionId>t2345</merc:localTransactionId>
                   <merc:initiator>
                       <com:login>a13</com:login>
                   </merc:initiator>
                   <base:guid>GUID</base:guid>
                   <ent:enterpriseGuid>guid</ent:enterpriseGuid>
              </merc:getStockEntryByGuidRequest> 
           </app:data>
        </app:application>
      </ws:submitApplicationRequest>
   </soapenv:Body>
</soapenv:Envelope>

Коды ошибок

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

Код ошибки Описание
MERC34008 Запись складского журнала продукции с указанным идентификатором не найдена в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC34180 Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.

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

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