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

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


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


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


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


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


==Данные запроса==
==Спецификация запроса==
 
===Объект getSubProductByGuidRequest===
 
Корневой элемент запроса. Содержит глобальный идентификатор вида продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''GUID''' || Уникальный глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
 
==Данные ответа==
 
===Объект getSubProductByGuidResponse===
 
Корневой объект ответа. Содержит информацию о запрашиваемом виде продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/subProduct|'''subProduct''']] || Вид продукции. || [[SubProduct|prod:SubProduct]] || 1
|}
 
===Объект [[#Объект getSubProductByGuidResponse|..Response]]/'''subProduct'''===


Объект описывает свойства вида продукции.
==Спецификация ответа==
 
{{Ветис.API ProductService Subproduct}}


==Описание ошибок==
==Описание ошибок==
Строка 75: Строка 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:getSubProductByGuidRequest>
      <base:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</base:guid>
    </ws:getSubProductByGuidRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 93: Строка 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:getSubProductByGuidResponse 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:getSubProductByGuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

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

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

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

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

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

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

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

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

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

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

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

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

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


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