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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 59: Строка 59:
|-
|-
| [[#Объект ..Request/productList|'''productList''']] || Список продукции выбранного типа || [[ProductList|prod:ProductList]] || 1
| [[#Объект ..Request/productList|'''productList''']] || Список продукции выбранного типа || [[ProductList|prod:ProductList]] || 1
|}
===Объект [[#Объект getProductByTypeListResponse |..Response]]/productList===
Список продукции, полученной в результате запроса.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''product''' || Данные о продукции || [[Product|prod:Product]] || 0..*
|}
===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/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] || Текст ячейки
|-
| '''updateDate''' || Дата обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || Текст ячейки
|-
| '''name''' || Название продукции || [[String255|bs:String255]] || Текст ячейки
|-
| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || Текст ячейки
|-
| '''productType''' || Тип продукции || [[ProductType|prod:ProductType]] || Текст ячейки
|}
|}

Версия 12:26, 4 июля 2016

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

Метод позволяет получить список продукции по указанному типу.

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

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

Объект 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..*


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

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

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