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

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

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

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

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

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

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

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

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

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

данные о запрашиваемом продукте.

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

Объект getProductByGuidRequest

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

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

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

Объект getProductByGuidResponse

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

Поле	Описание	Тип	Обязательность
product	Объект содержит данные о продукции.	prod:Product	1

Объект ..Response/product

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

Поле	Описание	Тип	Обязательность
UUID	Идентификатор версии записи продукции в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор продукции в реестре Россельхознадзора.	bs:UUID	1
active	Флаг, указывающий на то, активна ли запись.	xs:boolean	1
last	Флаг, указывающий на то, является ли запись последней.	xs:boolean	1
status	Статус версии записи.	xs:string	1
createDate	Дата создания записи о продукции в реестре Росcельхознадзора.	xs:dateTime	1
updateDate	Дата последнего обновления записи в реестре Россельхознадзора.	xs:dateTime	1
previous	Идентификатор предыдущей версии записи.	bs:UUID	0..1
name	Название продукции.	xs:string	1
code	Код ТН ВЭД продукции.	xs:string	1
productType	Тип продукции (первый уровень иерархии справочника продукции).	prod:ProductType	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:getProductByGuidRequest>
      <base:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:guid>
    </ws:getProductByGuidRequest>
  </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: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>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:getProductByGuidResponse>
  </S:Body>
</soapenv:Envelope>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Метод позволяет получить последнюю запись о продукции по её глобальному идентификатору. Глобальный идентификатор продукции содержится в ветеринарных сертификатах.
+Операция '''GetProductByGuid''' предназначена для получения актуальной версии записи продукции по её глобальному идентификатору (active=true, last=true). Глобальный идентификатор продукции содержится в ветеринарных сертификатах. Выполнение операции заканчивается либо возвратом объекта продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 ===Используемые пространства имён и типы===
@@ Строка 8: / Строка 8: @@
 * [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
 ** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
-** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:date]
+** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
 ** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
 {{столбец}}
@@ Строка 17: / Строка 17: @@
 ** [[UUID|bs:UUID]]
 {{столбцы/конец}}
+===[[#Объект getProductByGuidRequest|Входные данные]]===
+* глобальный уникальный идентификатор продукта.
+===[[#Объект getProductByGuidResponse|Выходные данные]]===
+* данные о запрашиваемом продукте.
 ==Данные запроса==
@@ Строка 40: / Строка 46: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''GUID''' || Глобальный идентификатор продукции || [[UUID|bs:UUID]] || 1
+| '''GUID''' || Глобальный идентификатор продукции. || [[UUID|bs:UUID]] || 1
 |}
@@ Строка 76: / Строка 82: @@
 ! Поле !! Описание !! Тип !! Обязательность
 |-
-| '''UUID''' || Идентификатор версии записи о продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
+| [[#Объект ..Response/product|'''product''']] || Объект содержит данные о продукции. || [[Product|prod:Product]] || 1
+|}
+===Объект [[#Объект getProductByGuidResponse|..Response]]/'''product'''===
+Объект соержит данные о продукции.
+{{Ветис.API ProductService Product}}
+==Описание ошибок==
+{| class="wikitable"
 |-
-| '''GUID''' || Глобальный идентификатор продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
+! Ошибка !! Описание
 |-
-| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
+| '''InternalServiceFault'''  || Внутренняя ошибка сервиса.
 |-
-| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
+| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
 |-
-| '''createDate''' || Дата создания записи о продукции в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
+| '''EntityNotFoundFault'''  || Объект с заданными параметрами не найден в базе.
-|-
-| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
-|-
-| '''name''' || Название продукции || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''code''' || Код ТН ВЭД продукции || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''productType''' || Тип продукции (первый уровень иерархии справочника продукции) || [[ProductType|prod:ProductType]] || 1
 |}
 ==Пример запроса==
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Запрос данных о продукции "Готовые мясные продукты"
+Запрос на получение данных о продукции "Готовые мясные продукты".
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
@@ Строка 104: / Строка 111: @@
                    xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"
                    xmlns:base="http://api.vetrf.ru/schema/cdm/base">
-   <soapenv:Header/>
+  <soapenv:Header/>
-   <soapenv:Body>
+  <soapenv:Body>
-      <ws:getProductByGuidRequest>
+    <ws:getProductByGuidRequest>
-         <base:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:guid>
+      <base:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:guid>
-      </ws:getProductByGuidRequest>
+    </ws:getProductByGuidRequest>
-   </soapenv:Body>
+  </soapenv:Body>
-</soapenv:Envelope
+</soapenv:Envelope>
+</syntaxhighlight>
+</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: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>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:getProductByGuidResponse>
+  </S:Body>
+</soapenv:Envelope>
 </syntaxhighlight>
 </div>
 </div>
+[[Category:Ветис.API]]
+[[Category:ProductService]]
+[[Category:Реестры]]