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

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

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

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

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

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

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

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

Объект getProductByTypeListRequest

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры запрашиваемого списка.	bs:ListOptions	0..1
productType	Тип продукции, по которому производится отбор.	prod:ProductType	1

Объект ..Request/listOptions

Объект содержит параметры запрашиваемого списка продукции.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке. По умолчанию значение равно 100; Максимально допустимое значение равно 1000.	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала.	xs:nonNegativeInteger	0..1

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

Объект getProductByTypeListResponse

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

Поле	Описание	Тип данных	Обязательность
productList	Список продукции выбранного типа.	prod:ProductList	1

Объект ..Response/productList

Список продукции, полученной в результате запроса.

Поле	Описание	Тип данных	Обязательность
product	Данные о продукции.	prod:Product	0..*

Атрибуты списка productList

Атрибут	Описание	Тип данных	Обязательность
count	Количество элементов списка, запрашиваемое или переданное.	xs:int	1
total	Общий размер списка.	xs:long	1
offset	Смещение первого элемента списка относительно его начала.	xs:int	1

Объект ..Response/productList/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, то есть сообщение не проходит валидацию.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос первых трёх элементов списка "Пищевые продукты" без смещения.

<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" 
                  xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getProductByTypeListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>0</base:offset>
      </base:listOptions> 
      <prod:productType>5</prod:productType>
    </ws:getProductByTypeListRequest>
  </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:getProductByTypeListResponse 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:productList count="3" total="18" offset="0">
        <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>
        <pro:product>
          <bs:uuid>31c94ff1-a217-f38d-6005-1aa5ca67e146</bs:uuid>
          <bs:guid>d34504bb-7a93-e1c8-4859-339eafd97c6c</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2011-05-23T10:49:01+03:00</bs:createDate>
          <bs:updateDate>2011-05-23T10:49:01+03:00</bs:updateDate>
          <pro:name>молоко и молочная продукция</pro:name>
          <pro:code>0401-0406,1905,1517</pro:code>
          <pro:productType>5</pro:productType>
        </pro:product>
        <pro:product>
          <bs:uuid>84128278-7db4-1e11-da35-4ac7128569c6</bs:uuid>
          <bs:guid>5f157caa-8f3b-4666-d3b0-5df86f8afb66</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2011-05-23T10:51:18+03:00</bs:createDate>
          <bs:updateDate>2011-05-23T10:51:18+03:00</bs:updateDate>
          <pro:name>яйца и продукты их переработки</pro:name>
          <pro:code>0407,0408,2103,2106,3502</pro:code>
          <pro:productType>5</pro:productType>
        </pro:product>
      </pro:productList>
    </ws:getProductByTypeListResponse>
  </S:Body>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Метод позволяет получить список продукции по указанному типу.
+Операция '''GetProductByTypeList''' предназначена для получения списка продукции по указанному типу. Тип продукции указан номером, посмотреть его можно [[ProductService#Уровни продукции|здесь]]. Выполнение операции заканчивается либо возвратом списка продукции(active = true, last = true), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 ===Используемые пространства имён и типы===
@@ Строка 30: / Строка 30: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка || [[ListOptions|bs:ListOptions]] || 0..1
+| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
 |-
-| '''productType''' || Тип продукции, по которому производится отбор || [[ProductType|prod:ProductType]] || 1
+| '''productType''' || Тип продукции, по которому производится отбор. || [[ProductType|prod:ProductType]] || 1
 |}
-===Объект [[#Объект getProductByTypeListRequest|..Request]]/listOptions===
+===Объект [[#Объект getProductByTypeListRequest|..Request]]/'''listOptions'''===
 Объект содержит параметры запрашиваемого списка продукции.
@@ Строка 43: / Строка 43: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''count''' || Количество значений в списке
+| '''count''' || Количество значений в списке.
 * По умолчанию значение равно 100;
-* Максимально допустимое значение равно 1000
+* Максимально допустимое значение равно 1000.
 || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |-
-| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
+| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |}
 ==Данные ответа==
@@ Строка 62: / Строка 61: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/productList|'''productList''']] || Список продукции выбранного типа || [[ProductList|prod:ProductList]] || 1
+| [[#Объект ..Response/productList|'''productList''']] || Список продукции выбранного типа. || [[ProductList|prod:ProductList]] || 1
 |}
+===Объект [[#Объект getProductByTypeListResponse |..Response]]/'''productList'''===
-===Объект [[#Объект getProductByTypeListResponse |..Response]]/productList===
 Список продукции, полученной в результате запроса.
@@ Строка 74: / Строка 72: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''product''' || Данные о продукции || [[Product|prod:Product]] || 0..*
+| [[#Объект ..Response/productList/product|'''product''']] || Данные о продукции. || [[Product|prod:Product]] || 0..*
 |}
+'''Атрибуты списка productList'''
+{{Ветис.API EntityList Attributes}}
-===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/product===
+===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/'''product'''===
 Описание продукции.
+{{Ветис.API ProductService Product}}
+==Описание ошибок==
 {| class="wikitable"
 |-
-! Поле !! Описание !! Тип данных !! Обязательность
+! Ошибка !! Описание
-|-
-| '''UUID''' || Уникальный идентификатор версии записи продукции || [[UUID|bs:UUID]] || 1
-|-
-| '''GUID''' || Глобальный уникальный идентификатор продукции || [[UUID|bs:UUID]] || 1
-|-
-| '''active''' || Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
-|-
-| '''last''' || Флаг, указывающий, последняя ли запись || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || Текст ячейки
-|-
-| '''status''' || Статус записи. Обозначает причину появления текущей версии записи. || [http://www.w3.org/TR/xmlschema-2/#integer xs:integer] || Текст ячейки
-|-
-| '''createDate''' || Дата создания записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || Текст ячейки
 |-
-| '''updateDate''' || Дата обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || Текст ячейки
+| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
 |-
-| '''name''' || Название продукции || [[String255|bs:String255]] || Текст ячейки
+| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
 |-
-| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || Текст ячейки
+| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
-|-
-| '''productType''' || Тип продукции || [[ProductType|prod:ProductType]] || Текст ячейки
 |}
@@ Строка 110: / Строка 99: @@
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Запрос данных о продукции "Готовые мясные продукты"
+Запрос первых трёх элементов списка "Пищевые продукты" без смещения.
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
@@ Строка 117: / Строка 106: @@
                    xmlns:base="http://api.vetrf.ru/schema/cdm/base"
                    xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production">
-   <soapenv:Header/>
+  <soapenv:Header/>
-   <soapenv:Body>
+  <soapenv:Body>
-      <ws:getProductByTypeListRequest>
+    <ws:getProductByTypeListRequest>
-         <base:listOptions>
+      <base:listOptions>
-           <base:count>10</base:count>
+        <base:count>3</base:count>
-           <base:offset>0</base:offset>
+        <base:offset>0</base:offset>
-         </base:listOptions>
+      </base:listOptions>
-         <prod:productType>5</prod:productType>
+      <prod:productType>5</prod:productType>
-      </ws:getProductByTypeListRequest>
+    </ws:getProductByTypeListRequest>
-   </soapenv:Body>
+  </soapenv:Body>
 </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:getProductByTypeListResponse 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:productList count="3" total="18" offset="0">
+        <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>
+        <pro:product>
+          <bs:uuid>31c94ff1-a217-f38d-6005-1aa5ca67e146</bs:uuid>
+          <bs:guid>d34504bb-7a93-e1c8-4859-339eafd97c6c</bs:guid>
+          <bs:active>true</bs:active>
+          <bs:last>true</bs:last>
+          <bs:status>100</bs:status>
+          <bs:createDate>2011-05-23T10:49:01+03:00</bs:createDate>
+          <bs:updateDate>2011-05-23T10:49:01+03:00</bs:updateDate>
+          <pro:name>молоко и молочная продукция</pro:name>
+          <pro:code>0401-0406,1905,1517</pro:code>
+          <pro:productType>5</pro:productType>
+        </pro:product>
+        <pro:product>
+          <bs:uuid>84128278-7db4-1e11-da35-4ac7128569c6</bs:uuid>
+          <bs:guid>5f157caa-8f3b-4666-d3b0-5df86f8afb66</bs:guid>
+          <bs:active>true</bs:active>
+          <bs:last>true</bs:last>
+          <bs:status>100</bs:status>
+          <bs:createDate>2011-05-23T10:51:18+03:00</bs:createDate>
+          <bs:updateDate>2011-05-23T10:51:18+03:00</bs:updateDate>
+          <pro:name>яйца и продукты их переработки</pro:name>
+          <pro:code>0407,0408,2103,2106,3502</pro:code>
+          <pro:productType>5</pro:productType>
+        </pro:product>
+      </pro:productList>
+    </ws:getProductByTypeListResponse>
+  </S:Body>
+</syntaxhighlight>
+</div>
+</div>
+[[Category:Ветис.API]]
+[[Category:ProductService]]
+[[Category:Реестры]]