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

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

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

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

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

xs (http://www.w3.org/2001/XMLSchema)

prod (http://api.vetrf.ru/schema/cdm/argus/production)
- prod:Product
- prod:SubProduct
bs (http://api.vetrf.ru/schema/cdm/base)
- bs:UUID

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

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

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

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

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

Объект getSubProductByGuidRequest

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

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

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

Объект getSubProductByGuidResponse

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

Поле	Описание	Тип	Обязательность
subProduct	Вид продукции.	prod:SubProduct	1

Объект ..Response/subProduct

Объект описывает свойства вида продукции.

Поле	Описание	Тип	Обязательность
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
englishName	Английское название вида продукции.	bs:String255	0..1
productGuid	Идентификатор продукции (второй уровень иерархии справочника продукции).	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:getSubProductByGuidRequest>
      <base:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</base:guid>
    </ws:getSubProductByGuidRequest>
  </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: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>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Операция '''GetSubProductByGuid''' предназанчена для получения записи о виде продукции по глобальному идентификатору. В ответе приходит актуальная последняя запись продукции (active=true, last=true).
+Операция '''GetSubProductByGuid''' предназначена для получения актуальной версии записи о виде продукции по глобальному идентификатору (active=true, last=true). Выполнение операции заканчивается либо возвратом объекта записи вида продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 ===Используемые пространства имён и типы===
@@ Строка 14: / Строка 14: @@
 *  [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/production|prod]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/production</nowiki>)
 ** [[Product|prod:Product]]
-** [[ProductType|prod:SubProduct]]
+** [[SubProduct|prod:SubProduct]]
 * [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
 ** [[UUID|bs:UUID]]
@@ Строка 72: / Строка 72: @@
 ==Пример запроса==
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Запрос данных о виде продукции
+Запрос данных о виде продукции.
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
@@ Строка 90: / Строка 90: @@
 <br />
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Ответ на запрос
+Ответ на запрос.
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
@@ Строка 116: / Строка 116: @@
 </div>
 </div>
+[[Category:Ветис.API]]
+[[Category:ProductService]]
+[[Category:Реестры]]