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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Метод позволяет получить список наименований продукции отфильтрован…»)
 
Строка 22: Строка 22:
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
{{столбцы/конец}}
{{столбцы/конец}}
==Данные запроса==
===Объект getProductItemListRequest===
Корневой элемент запроса.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''listOptions''' || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| '''subProductGuid''' || Вид продукции, для которого нужно получить номенклатуру || [[UUID|bs:UUID]] || 1
|-
| '''enterpriseGuid''' || Идентификатор предприятия, на котором производится или хранится продукция || [[UUID|bs:UUID]] || 1
|}
===Объект [[#Объект getProductItemListRequest|..Request]]/listOptions===
Объект содержит параметры запрашиваемого списка продукции.
{| 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
|}
==Данные ответа==
===Объект getProductItemListResponse===
Корневой объект, описывающий получаемый результат.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productItemList|'''productItemList''']] || Список продукции || [[ProductItemList|prod:ProductItemList]] || 1
|}
===Объект [[#Объект getProductItemListResponse|..Response]]/'''productItemList'''===
Объект, описывающий единицу номенклатуры производителя.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''productItem''' || Сущность, описывающая единицу номенклатуры. || [[ProductItem|prod:ProductItem]] || 1
|}
===Объект [[#Объект getProductItemListResponse|..Response]]/productItemList/'''productItem'''===
Объект описывает сущность единицы номенклатуры.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Текст ячейки || Текст ячейки || Текст ячейки
|-
| '''GUID''' || Текст ячейки || Текст ячейки || Текст ячейки
|-
| active || Текст ячейки || Текст ячейки || Текст ячейки
|-
| last || Текст ячейки || Текст ячейки || Текст ячейки
|-
| status || Текст ячейки || Текст ячейки || Текст ячейки
|-
| createDate || Текст ячейки || Текст ячейки || Текст ячейки
|-
| updateDate || Текст ячейки || Текст ячейки || Текст ячейки
|-
| previous || Текст ячейки || Текст ячейки || Текст ячейки
|-
| next || Текст ячейки || Текст ячейки || Текст ячейки
|-
| name || Текст ячейки || Текст ячейки || Текст ячейки
|-
| productType || Текст ячейки || Текст ячейки || Текст ячейки
|-
| product || Текст ячейки || Текст ячейки || Текст ячейки
|-
| subProduct || Текст ячейки || Текст ячейки || Текст ячейки
|-
| correspondToGost || Текст ячейки || Текст ячейки || Текст ячейки
|-
| gost || Текст ячейки || Текст ячейки || Текст ячейки
|}
==Пример запроса==

Версия 16:44, 11 июля 2016

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

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

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

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

Объект getProductItemListRequest

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

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

Объект ..Request/listOptions

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

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

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

Объект getProductItemListResponse

Корневой объект, описывающий получаемый результат.

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


Объект ..Response/productItemList

Объект, описывающий единицу номенклатуры производителя.

Поле Описание Тип данных Обязательность
productItem Сущность, описывающая единицу номенклатуры. prod:ProductItem 1

Объект ..Response/productItemList/productItem

Объект описывает сущность единицы номенклатуры.

Поле Описание Тип данных Обязательность
UUID Текст ячейки Текст ячейки Текст ячейки
GUID Текст ячейки Текст ячейки Текст ячейки
active Текст ячейки Текст ячейки Текст ячейки
last Текст ячейки Текст ячейки Текст ячейки
status Текст ячейки Текст ячейки Текст ячейки
createDate Текст ячейки Текст ячейки Текст ячейки
updateDate Текст ячейки Текст ячейки Текст ячейки
previous Текст ячейки Текст ячейки Текст ячейки
next Текст ячейки Текст ячейки Текст ячейки
name Текст ячейки Текст ячейки Текст ячейки
productType Текст ячейки Текст ячейки Текст ячейки
product Текст ячейки Текст ячейки Текст ячейки
subProduct Текст ячейки Текст ячейки Текст ячейки
correspondToGost Текст ячейки Текст ячейки Текст ячейки
gost Текст ячейки Текст ячейки Текст ячейки

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

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