GetProductByUuid v2.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetProductByUuid''' предназначена для получения записи продукции по…»)
 
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


Операция '''GetProductByUuid''' предназначена для получения записи продукции по идентификатору версии записи.Уникальный идентификатор версии записи продукции содержится в ветеринарных сертификатах. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной  (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Операция '''GetProductByUuid''' предназначена для получения записи продукции (2 уровень иерархического справочника) по идентификатору версии записи. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной  (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 
<!--===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
{{столбцы}}
{{столбцы}}
{{столбец}}
{{столбец}}
Строка 16: Строка 15:
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
{{столбцы/конец}}
{{столбцы/конец}}-->


===[[#Объект getProductByUuidRequest|Входные данные]]===
===Входные данные===
* уникальный идентификатор версии записи продукции.
* уникальный идентификатор версии записи продукции.


===[[#Объект getProductByUuidResponse |Выходные данные]]===
===Выходные данные===
* данные о продукции.
* данные о продукции.


==Данные запроса==
==Спецификация запроса==
 
<!--<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<ws:getProductByGuidRequest>
        <base:uuid>{base:guid}</base:uuid>
      </ws:getProductByGuidRequest>
</syntaxhighlight>
</div>
</div>
-->
===Объект getProductByUuidRequest===
 
Корневой элемент запроса.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
 
==Данные ответа==
 
<!--- div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<ws:getProductByUuidResponse 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> -->
 
===Объект getProductByUuidResponse===


Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
==Спецификация ответа==
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/product|'''product''']] || Объект, содержащий сведения о продукции. || [[Product|prod:Product]] || 1
|}
 
===Объект [[#Объект getProductByUuidResponse|..Response]]/'''product'''===
 
Объект содержит свойства возвращаемой продукции.
 
{{Ветис.API ProductService Product|1}}


==Описание ошибок==
==Описание ошибок==
Строка 106: Строка 44:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<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:getSubProductByUuidRequest>
      <base:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</base:uuid>
    </ws:getSubProductByUuidRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 124: Строка 53:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getProductByUuidResponse 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>3008afa9-8a88-8586-5f75-08ce43189ac8</bs:uuid>
        <bs:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2011-05-23T10:35:08+03:00</bs:createDate>
        <bs:updateDate>2011-05-23T10:35:08+03:00</bs:updateDate>
        <pro:name>готовые мясные продукты</pro:name>
        <pro:code>0210, 1601, 1602</pro:code>
        <pro:productType>5</pro:productType>
      </pro:product>
    </ws:getProductByUuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

Версия 22:22, 29 октября 2017

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

Операция GetProductByUuid предназначена для получения записи продукции (2 уровень иерархического справочника) по идентификатору версии записи. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

  • уникальный идентификатор версии записи продукции.

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

  • данные о продукции.

Спецификация запроса

Спецификация ответа

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

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

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

Запрос на получение данных о продукции "Готовые мясные продукты".


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

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