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

Текущая версия на 09:16, 25 августа 2017

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

Операция GetSubProductByProductList предназначена для получения списка видов продукции, отфильтрованного по указанному продукту. В список попадают только актуальные последние записи (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

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

Объект getSubProductByProductListRequest

Корневой объект запроса.

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

Объект ..Request/listOptions

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

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

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

Объект getSubProductByProductListResponse

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

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

Объект ..Response/subProductList

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

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

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

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

Запрос данных 3 видов продукции со смещением 2 от начала списка.

<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:getSubProductByProductListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>2</base:offset>
      </base:listOptions>
      <prod:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</prod:productGuid>
    </ws:getSubProductByProductListRequest>
  </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:getSubProductByProductListResponse 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:subProductList count="3" total="23" offset="2">
        <pro:subProduct>
          <bs:uuid>41e78ed2-f727-ec66-4d76-25fda8c61316</bs:uuid>
          <bs:guid>c7cf9fdc-6b23-def0-dc46-20c124bb793e</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
          <pro:name>курица домашняя: "части тушек обваленные, охлажденные"</pro:name>
          <pro:code>0207131</pro:code>
          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
        </pro:subProduct>
        <pro:subProduct>
          <bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
          <bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
          <pro:name>курица домашняя: "части тушек необваленные, охлажденные"</pro:name>
          <pro:code>0207132-0207137</pro:code>
          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
        </pro:subProduct>
        <pro:subProduct>
          <bs:uuid>ca4a9f4d-3845-4194-d4b6-07f3d8e6f3e0</bs:uuid>
          <bs:guid>4c7ee80b-d421-5239-7d98-a764707b81f8</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
          <pro:name>курица домашняя: "части тушек обваленные мороженые"</pro:name>
          <pro:code>0207141</pro:code>
          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
        </pro:subProduct>
      </pro:subProductList>
    </ws:getSubProductByProductListResponse>
  </S:Body>
</soapenv:Envelope>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Метод позволяет получить список видов продукции отфильтрованный по указанному продукту.   В список попадают только актуальные записи (active=true). Метод поддерживает возможность постраничного вывода.
+Операция '''GetSubProductByProductList''' предназначена для получения списка видов продукции, отфильтрованного по указанному продукту. В список попадают только актуальные последние записи (active=true, last=true). Метод поддерживает возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка видов продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 ===Используемые пространства имён и типы===
@@ Строка 10: / Строка 10: @@
 ** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
 ** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
-** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
 ** [http://www.w3.org/TR/xmlschema-2/#string xs:integer]
 ** [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
@@ Строка 18: / Строка 17: @@
 ** [[SubProduct|prod:SubProduct]]
 ** [[SubProductList|prod:SubProductList]]
+{{столбец}}
 * [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
 ** [[UUID|bs:UUID]]
@@ Строка 25: / Строка 26: @@
 ==Данные запроса==
-===Объект getProductByTypeListRequest===
+===Объект getSubProductByProductListRequest===
+Корневой объект запроса.
 {| class="wikitable"
 |-
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка || [[ListOptions|bs:ListOptions]] || 0..1
+| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
 |-
-| '''productGuid''' || Глобальный идентифкатор продукции, по которому производится отбор || [[Product|prod:Product]] || 1
+| '''productGuid''' || Глобальный идентифкатор продукции, по которому производится отбор. || [[UUID|bs:UUID]] || 1
 |}
-===Объект [[#Объект getSubProductByProductListRequest|..Request]]/listOptions===
+===Объект [[#Объект getSubProductByProductListRequest|..Request]]/'''listOptions'''===
 Объект содержит параметры запрашиваемого списка продукции.
@@ Строка 43: / Строка 46: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''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
 |}
 ==Данные ответа==
-===Объект getProductByTypeListResponse===
+===Объект getSubProductByProductListResponse===
 Корневой элемент ответа.
@@ Строка 62: / Строка 64: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/subProductList|'''subProductList''']] || Список продукции выбранного типа || [[SubProductList|prod:SubProductList]] || 1
+| [[#Объект ..Response/subProductList|'''subProductList''']] || Список видов продукции указанной в запросе. || [[SubProductList|prod:SubProductList]] || 1
 |}
+===Объект [[#Объект getSubProductByProductListResponse |..Response]]/'''subProductList'''===
-===Объект [[#Объект getSubProductByProductListResponse |..Response]]/subProductList===
 Список продукции, полученной в результате запроса.
@@ Строка 74: / Строка 75: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''[[#Объект ..Response/subProductList/subProduct|subProduct]]''' || Данные о продукции || [[SubProduct|prod:SubProduct]] || 0..*
+| '''[[#Объект ..Response/subProductList/subProduct|subProduct]]''' || Данные о продукции. || [[SubProduct|prod:SubProduct]] || 0..*
 |}
-===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/subProductList|subProductList]]/subProduct===
+===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/subProductList|subProductList]]/'''subProduct'''===
 Описание вида продукции.
+{{Ветис.API ProductService Subproduct}}
+==Описание ошибок==
 {| 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] || 1
-|-
-| '''status''' || Статус записи. Обозначает причину появления текущей версии записи. || [http://www.w3.org/TR/xmlschema-2/#integer xs:integer] || 1
-|-
-| '''createDate''' || Дата создания записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
-|-
-| '''updateDate''' || Дата обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
-|-
-| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
-|-
-| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
 |-
-| '''name''' || Название продукции || [[String255|bs:String255]] || 1
+| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
 |-
-| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || 1
+| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
 |-
-| '''productGuid''' || Идентификатор продукции || [[ProductType|prod:ProductType]] || 1
+| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
 |}
@@ Строка 113: / Строка 99: @@
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Запрос данных о видах продукции "Готовые мясные продукты"
+Запрос данных 3 видов продукции со смещением 2 от начала списка.
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
@@ Строка 120: / Строка 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:getSubProductByProductListRequest>
+    <ws:getSubProductByProductListRequest>
-        <base:listOptions>
+      <base:listOptions>
-            <base:count>100</base:count>
+        <base:count>3</base:count>
-            <base:offset>0</base:offset>
+        <base:offset>2</base:offset>
-         </base:listOptions>
+      </base:listOptions>
-         <prod:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</prod:productGuid>
+      <prod:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</prod:productGuid>
-      </ws:getSubProductByProductListRequest>
+    </ws:getSubProductByProductListRequest>
-   </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:getSubProductByProductListResponse 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:subProductList count="3" total="23" offset="2">
+        <pro:subProduct>
+          <bs:uuid>41e78ed2-f727-ec66-4d76-25fda8c61316</bs:uuid>
+          <bs:guid>c7cf9fdc-6b23-def0-dc46-20c124bb793e</bs:guid>
+          <bs:active>true</bs:active>
+          <bs:last>true</bs:last>
+          <bs:status>100</bs:status>
+          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
+          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
+          <pro:name>курица домашняя: "части тушек обваленные, охлажденные"</pro:name>
+          <pro:code>0207131</pro:code>
+          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
+        </pro:subProduct>
+        <pro:subProduct>
+          <bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
+          <bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
+          <bs:active>true</bs:active>
+          <bs:last>true</bs:last>
+          <bs:status>100</bs:status>
+          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
+          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
+          <pro:name>курица домашняя: "части тушек необваленные, охлажденные"</pro:name>
+          <pro:code>0207132-0207137</pro:code>
+          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
+        </pro:subProduct>
+        <pro:subProduct>
+          <bs:uuid>ca4a9f4d-3845-4194-d4b6-07f3d8e6f3e0</bs:uuid>
+          <bs:guid>4c7ee80b-d421-5239-7d98-a764707b81f8</bs:guid>
+          <bs:active>true</bs:active>
+          <bs:last>true</bs:last>
+          <bs:status>100</bs:status>
+          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
+          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
+          <pro:name>курица домашняя: "части тушек обваленные мороженые"</pro:name>
+          <pro:code>0207141</pro:code>
+          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
+        </pro:subProduct>
+      </pro:subProductList>
+    </ws:getSubProductByProductListResponse>
+  </S:Body>
 </soapenv:Envelope>
 </syntaxhighlight>
 </div>
 </div>
+[[Category:Ветис.API]]
+[[Category:ProductService]]
+[[Category:Реестры]]