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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показано 14 промежуточных версий 2 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


Метод позволяет получить последнюю запись о продукции по её глобальному идентификатору. Глобальный идентификатор продукции содержится в ветеринарных сертификатах.
Операция '''GetProductItemByGuid''' предназначена для получения последней актуальной (last = true, active = true) записи о номенклатуре производителя по её глобальному идентификатору. Глобальный идентификатор присваивается номенклатуре при занесении её в список с помощью метода [[ModifyProducerStockListOperation|ModifyProducerStockListOperation]]. Выполнение операции заканчивается либо возвратом объекта номенклатуры производителя , либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 17: Строка 17:
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getProductItemByGuidRequest|Входные данные]]===
* глобальный уникальный идентификатор номенклатуры производителя.
===[[#Объект getProductItemByGuidResponse|Выходные данные]]===
* занесённые данные номенклатуры производителя.


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


<!--<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<ws:getProductItemByGuidRequest>
        <base:guid>{base:guid}</base:guid>
      </ws:getProductItemByGuidRequest>
</syntaxhighlight>
</div>
</div>
-->
===Объект getProductItemByGuidRequest===
===Объект getProductItemByGuidRequest===


Строка 40: Строка 34:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''GUID''' || Глобальный идентификатор наименования номенклатуры производителя || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный идентификатор наименования номенклатуры производителя. || [[UUID|bs:UUID]] || 1
|}
|}


==Данные ответа==
==Данные ответа==
<!--- div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<ws:getProductByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production" xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
        <pro:product>
            <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>
            <pro:name>{bs:String255}</pro:name>
            <pro:code>{bs:String255}</pro:code>
            <pro:productType>{prod:ProductType}</pro:productType>
        </pro:product>
      </ws:getProductByGuidResponse>
</syntaxhighlight>
</div>
</div> -->


===Объект getProductItemByGuidResponse===
===Объект getProductItemByGuidResponse===
Строка 76: Строка 47:
! Поле !! Описание !! Тип !! Обязательность
! Поле !! Описание !! Тип !! Обязательность
|-
|-
| [[#Объект ..Response/productItem|'''productItem''']] || Сущность, описывающая номенклатуру производителя || [[ProductItem|prod:ProductItem]] || 0..1
| [[#Объект ..Response/productItem|'''productItem''']] || Сущность, описывающая номенклатуру производителя. || [[ProductItem|prod:ProductItem]] || 0..1
|}
|}


===Объект [[#Объект getProductByGuidResponse|..Response]]/productItem===
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/'''productItem'''===


Объект содержит данные о единице номенклатуры продукции.
{{Ветис.API ProductService ProductItem}}
 
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/[[#Объект ..Response/productItem|productItem]]/'''product'''===
 
Объект содержит информацию о продукции. Возвращаются только идентификаторы.


{| class="wikitable"
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип !! Обязательность
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
|-
| '''UUID''' || Идентификатор версии записи о продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''UUID''' || Идентификатор версии записи о продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|-
| '''GUID''' || Глобальный идентификатор продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный идентификатор продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/[[#Объект ..Response/productItem|productItem]]/'''subProduct'''===
 
Объект содержит информацию о продукции. Возвращаются только идентификаторы.
 
{| class="wikitable"
|-
|-
| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
|-
| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''UUID''' || Идентификатор версии записи о виде продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|-
| '''createDate''' || Дата создания записи о продукции в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
| '''GUID''' || Глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|}
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 0..1
 
|-
==Описание ошибок==
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
 
{| class="wikitable"
|-
|-
| '''next''' || Идентификатор следующей версии журнала || [[UUID|bs:UUID]] || 0..1
! Ошибка !! Описание
|-
|-
| '''name''' || Название продукции || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
|-
| '''code''' || Код ТН ВЭД продукции || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.  
|-
|-
| '''subProductGuid''' || Вид продукции (третий уровень иерархии справочника продукции) || [[UUID|bs:UUID]] || 1
| '''EntityNotFoundFault''' || Объект с заданными параметрами не найден в базе.
 
|}
|}


==Пример запроса==
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос данных о номенклатуре производителя
Запрос данных о номенклатуре производителя по его глобальному идентификатору.
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Строка 119: Строка 101:
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"  
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"  
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Header/>
  <soapenv:Body>
  <soapenv:Body>
      <ws:getProductItemByGuidRequest>
    <ws:getProductItemByGuidRequest>
        <base:guid>guid</base:guid>
      <base:guid>6585132b-725a-4838-9571-7a8d10d361e2</base:guid>
      </ws:getProductItemByGuidRequest>
    </ws:getProductItemByGuidRequest>
  </soapenv:Body>
  </soapenv:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getProductItemByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                                    xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production"
                                    xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
      <pro:productItem>
        <bs:uuid>e1cf5ff6-6da6-4ddf-984b-a22a1ce37a7d</bs:uuid>
        <bs:guid>6585132b-725a-4838-9571-7a8d10d361e2</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2016-11-16T13:50:08+03:00</bs:createDate>
        <bs:updateDate>2016-11-16T13:50:08+03:00</bs:updateDate>
        <pro:name>Пельмени холостяцкие условно-съедобные</pro:name>
        <pro:productType>5</pro:productType>
        <pro:product>
          <bs:uuid>26b81265-a498-0a42-5b77-08da2eb03ab9</bs:uuid>
          <bs:guid>b45f20b3-9ade-342e-976f-f1f3b2567c53</bs:guid>
        </pro:product>
        <pro:subProduct>
          <bs:uuid>92302080-0972-9504-94c9-6b0028ccbdb6</bs:uuid>
          <bs:guid>80b7fc16-110c-a663-67e3-b5d9ce3f02ff</bs:guid>
        </pro:subProduct>
        <pro:correspondToGost>false</pro:correspondToGost>
        <pro:gost>ГОСТ_Р_51184-98</pro:gost>
      </pro:productItem>
    </ws:getProductItemByGuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
[[Category:Ветис.API]]
[[Category:ProductService]]
[[Category:Реестры]]

Текущая версия на 09:45, 16 декабря 2016

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

Операция GetProductItemByGuid предназначена для получения последней актуальной (last = true, active = true) записи о номенклатуре производителя по её глобальному идентификатору. Глобальный идентификатор присваивается номенклатуре при занесении её в список с помощью метода ModifyProducerStockListOperation. Выполнение операции заканчивается либо возвратом объекта номенклатуры производителя , либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

Входные данные

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

Выходные данные

  • занесённые данные номенклатуры производителя.

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

Объект getProductItemByGuidRequest

Корневой элемент запроса.

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

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

Объект getProductItemByGuidResponse

Корневой объект ответа. Содержит информацию о запрашиваемой продукции.

Поле Описание Тип Обязательность
productItem Сущность, описывающая номенклатуру производителя. prod:ProductItem 0..1

Объект ..Response/productItem

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

Поле Описание Тип Обязательность
UUID Идентификатор версии записи о номенклатуре производителя в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор номенклатуры производителя в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активна ли запись. xs:boolean 1
last Флаг, указывающий на то, является ли запись последней. xs:boolean 1
status Статус версии записи. xs:string 1
createDate Дата создания записи о номенклатуре производителя в реестре Россельхознадзора. xs:date 1
updateDate Дата последнего обновления записи в реестре Россельхознадзора. xs:date 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
name Название номенклатуры производителя. xs:string 1
code Код ТН ВЭД номенклатуры производителя. xs:string 1
productType Тип продукции (первый уровень иерархии справочника продукции). prod:ProductType 1
product Продукция (второй уровень иерархии справочника продукции). prod:Product 1
subProduct Вид продукции (третий уровень иерархии справочника продукции). prod:SubProduct 1
correspondsToGost Флаг, указывающий на то, соответствует ли указанная продукция ГОСТу. xs:boolean 0..1
gost ГОСТ. bs:String255 0..1

Объект ..Response/productItem/product

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

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

Объект ..Response/productItem/subProduct

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

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

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
EntityNotFoundFault Объект с заданными параметрами не найден в базе.

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

Запрос данных о номенклатуре производителя по его глобальному идентификатору. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getProductItemByGuidRequest>
      <base:guid>6585132b-725a-4838-9571-7a8d10d361e2</base:guid>
    </ws:getProductItemByGuidRequest>
  </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getProductItemByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                     xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production" 
                                     xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
      <pro:productItem>
        <bs:uuid>e1cf5ff6-6da6-4ddf-984b-a22a1ce37a7d</bs:uuid>
        <bs:guid>6585132b-725a-4838-9571-7a8d10d361e2</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2016-11-16T13:50:08+03:00</bs:createDate>
        <bs:updateDate>2016-11-16T13:50:08+03:00</bs:updateDate>
        <pro:name>Пельмени холостяцкие условно-съедобные</pro:name>
        <pro:productType>5</pro:productType>
        <pro:product>
          <bs:uuid>26b81265-a498-0a42-5b77-08da2eb03ab9</bs:uuid>
          <bs:guid>b45f20b3-9ade-342e-976f-f1f3b2567c53</bs:guid>
        </pro:product>
        <pro:subProduct>
          <bs:uuid>92302080-0972-9504-94c9-6b0028ccbdb6</bs:uuid>
          <bs:guid>80b7fc16-110c-a663-67e3-b5d9ce3f02ff</bs:guid>
        </pro:subProduct>
        <pro:correspondToGost>false</pro:correspondToGost>
        <pro:gost>ГОСТ_Р_51184-98</pro:gost>
      </pro:productItem>
    </ws:getProductItemByGuidResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetProductItemByGuid&oldid=19266