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

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


Операция '''GetProductByTypeList''' предназначена для получения списка продукции по указанному типу. Тип продукции указан номером, посмотреть его можно [[ProductService#Уровни продукции|здесь]]. Выполнение операции заканчивается либо возвратом списка продукции(active = true, last = true), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Операция '''GetProductByTypeList''' предназначена для получения списка продукции по указанному типу. Тип продукции указан номером, посмотреть его можно [[ProductService#Уровни продукции|здесь]]. Выполнение операции заканчивается либо возвратом списка продукции(active = true, last = true), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 
<!--===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
 
{{столбцы}}
{{столбцы}}
{{столбец}}
{{столбец}}
Строка 21: Строка 19:
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
{{столбцы/конец}}
{{столбцы/конец}}-->


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


===Объект getProductByTypeListRequest===
===Входные данные===
{| class="wikitable"
* тип продукции (1 уровень иерархического справочника).
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| '''productType''' || Тип продукции, по которому производится отбор. || [[ProductType|prod:ProductType]] || 1
|}


===Объект [[#Объект getProductByTypeListRequest|..Request]]/'''listOptions'''===
===Выходные данные===
* список продукции (2 уровень иерархического справочника).


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


{| class="wikitable"
==Спецификация ответа==
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''count''' || Количество значений в списке.
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 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
|}
 
==Данные ответа==
 
===Объект getProductByTypeListResponse===
 
Корневой элемент ответа.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productList|'''productList''']] || Список продукции выбранного типа. || [[ProductList|prod:ProductList]] || 1
|}
 
===Объект [[#Объект getProductByTypeListResponse |..Response]]/'''productList'''===
 
Список продукции, полученной в результате запроса.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productList/product|'''product''']] || Данные о продукции. || [[Product|prod:Product]] || 0..*
|}
 
'''Атрибуты списка productList'''
{{Ветис.API EntityList Attributes}}
 
===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/'''product'''===
 
Описание продукции.
 
{{Ветис.API ProductService Product}}


==Описание ошибок==
==Описание ошибок==
Строка 102: Строка 50:
<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"
                  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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 125: Строка 59:
<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: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>
</syntaxhighlight>
</div>
</div>

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

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

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


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

  • тип продукции (1 уровень иерархического справочника).

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

  • список продукции (2 уровень иерархического справочника).

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

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

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

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

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

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


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

Источник — http://help.vetrf.ru/index.php?title=GetProductByTypeList_v2.0&oldid=22213