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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 22: Строка 22:
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getProductItemListRequest|Входные данные]]===
* параметры выводимого списка;
* глобальный идентификатор предприятия
===[[#Объект getProductItemListResponse|Выходные данные]]===
* список, отфильтрованный по виду продукции, выпускаемой на указанном предприятии


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

Версия 14:59, 16 ноября 2016

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

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

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

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

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи bs:UUID 1
GUID Глобальный идентификатор записи в реестре РСХН bs:UUID 1
active Флаг, указывающий, что запись активна xs:boolean 1
last Флаг, указывающий, последняя ли версия записи xs:boolean 1
status Статус записи, обозначает действие, приведшее к созданию записи bs:String255 1
createDate Дата создания записи xs:dateTime 1
updateDate Дата обновления записи xs:dateTime 0..1
previous Ссылка на предыдущую версию записи bs:UUID 0..1
next Ссылка на следующую версию записи bs:UUID 0..1
name Название продукции bs:String255 1
productType Тип продукции, к которой относится номенклатура prod:ProductType 1
product Продукция prod:Product 1
subProduct Вид продукции prod:SubProduct 1
correspondToGost Соответствует ли продукция ГОСТу xs:boolean 0..1
gost ГОСТ bs:String255 0..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" 
                  xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getProductItemListRequest>
         <base:listOptions>
            <base:count>1000</base:count>
            <base:offset>0</base:offset>
         </base:listOptions>
         <prod:subProductGuid>0acb8bc2-b461-11ae-eb8a-9322c72dc5e2</prod:subProductGuid>
         <ent:enterpriseGuid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</ent:enterpriseGuid>
      </ws:getProductItemListRequest>
   </soapenv:Body>
</soapenv:Envelope>