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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Метод позволяет получить список видов продукции отфильтрованный по у…»)
 
Строка 79: Строка 79:
===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/subProduct===
===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/subProduct===


Описание продукции.
Описание вида продукции.


{| class="wikitable"
{| class="wikitable"
Строка 91: Строка 91:
| '''active''' || Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
| '''active''' || Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
|-
| '''last''' || Флаг, указывающий, последняя ли запись || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || Текст ячейки
| '''last''' || Флаг, указывающий, последняя ли запись || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
|-
| '''status''' || Статус записи. Обозначает причину появления текущей версии записи. || [http://www.w3.org/TR/xmlschema-2/#integer xs:integer] || Текст ячейки
| '''status''' || Статус записи. Обозначает причину появления текущей версии записи. || [http://www.w3.org/TR/xmlschema-2/#integer xs:integer] || 1
|-
|-
| '''createDate''' || Дата создания записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || Текст ячейки
| '''createDate''' || Дата создания записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
|-
| '''updateDate''' || Дата обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || Текст ячейки
| '''updateDate''' || Дата обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
|-
| '''name''' || Название продукции || [[String255|bs:String255]] || Текст ячейки
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || Текст ячейки
| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''productGuid''' || Идентификатор продук || [[ProductType|prod:ProductType]] || Текст ячейки
| '''name''' || Название продукции || [[String255|bs:String255]] || 1
|-
| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || 1
|-
| '''productGuid''' || Идентификатор продук || [[ProductType|prod:ProductType]] || 1
|}
|}



Версия 13:42, 7 июля 2016

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

Метод позволяет получить список видов продукции отфильтрованный по указанному продукту. В список попадают только актуальные записи (active=true). Метод поддерживает возможность постраничного вывода.

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

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

Объект getProductByTypeListRequest

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

Объект ..Request/listOptions

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

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


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

Объект getProductByTypeListResponse

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

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


Объект ..Response/subProductList

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

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


Объект ..Response/productList/subProduct

Описание вида продукции.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи вида продукции bs:UUID 1
GUID Глобальный уникальный идентификатор вида продукции bs:UUID 1
active Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект xs:boolean 1
last Флаг, указывающий, последняя ли запись xs:boolean 1
status Статус записи. Обозначает причину появления текущей версии записи. xs:integer 1
createDate Дата создания записи xs:dateTime 1
updateDate Дата обновления записи xs:dateTime 1
previous Идентификатор предыдущей версии записи bs:UUID 0..1
next Идентификатор следующей версии записи bs:UUID 0..1
name Название продукции bs:String255 1
code Код ТН ВЭД продукции bs:String255 1
productGuid Идентификатор продук prod:ProductType 1

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

Запрос данных о продукции "Готовые мясные продукты"

<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>10</base:count>
           <base:offset>0</base:offset>
         </base:listOptions> 
         <prod:productType>5</prod:productType>
      </ws:getProductByTypeListRequest>
   </soapenv:Body>
</soapenv:Envelope>