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

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


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


{{столбцы}}
{{столбцы}}
Строка 17: Строка 16:
* [[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]]
{{столбцы/конец}}
{{столбцы/конец}}-->


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


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


==Данные запроса==
==Спецификация запроса==
 
===Объект getSubProductByUuidRequest===
 
Корневой элемент запроса. Содержит идентификатор версии записи вида продукции.
 
{| 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> -->
 
===Объект getSubProductByUuidResponse===
 
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[GetSubProductByUuid#Объект ..Response/subProduct|'''subProduct''']] || Объект содержит описание вида продукции. || [[SubProduct|prod:SubProduct]] || 1
|}
 
===Объект [[GetSubProductByUuid#Объект getSubProductByUuidResponse|..Response]]/'''subProduct'''===


{{Ветис.API ProductService Subproduct|1}}
==Спецификация ответа==


==Описание ошибок==
==Описание ошибок==
Строка 95: Строка 46:
<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>d9078e32-353c-eb56-3839-9bc09e79bdf5</base:uuid>
      </ws:getSubProductByUuidRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 113: Строка 55:
<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:getSubProductByUuidResponse 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:subProduct>
        <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
        <bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate>
        <bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate>
        <pro:name>мясо птицы</pro:name>
        <pro:code>0207</pro:code>
        <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
      </pro:subProduct>
    </ws:getSubProductByUuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

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

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

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

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

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

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

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

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

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

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

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

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

Запрос данных о виде продукции.


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

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