GetProductItemList v2.0

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

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

Операция GetProductItemList предназначена для получения списка наименований продукции с возможностью фильтрации по уровням продукции иерархического справочника, по номенклатуре определенного предприятия-производителя или всех предприятий определенного хозяйствующего субъекта. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Добавить записи номенклатуры производителя можно с помощью операции ModifyProducerStockListOperation. Выполнение операции заканчивается либо возвратом списка наименований продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

  • параметры выводимого списка;
  • идентификатор типа продукции (1 уровень иерархического справочника);
  • глобальный идентификатор продукции (2 уровень иерархического справочника).
  • глобальный идентификатор вида продукции (3 уровень иерархического справочника).
  • глобальный идентификатор предприятия-производителя.
  • глобальный идентификатор хозяйствующего субъекта.

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

  • список продукции (4 уровень иерархического справочника), отфильтрованный по заданным параметрам.

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getProductItemListRequest>
2 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
3 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
<bs:count>10</bs:count>
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
<bs:offset>2</bs:offset>
5 ···</bs:listOptions>
6 ···<vd:productType> dt:ProductType [0..1] Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий. <vd:productType>1</vd:productType>
7 ···<vd:product> dt:Product [0..1] Продукция. Второй уровень иерархического справочника продукции ИС Меркурий.
8 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор продукции. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
9 ···</vd:product>
10 ···<vd:subProduct> dt:SubProduct [0..1] Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.
11 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции. <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
12 ···</vd:subProduct>
13 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте.
14 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
15 ···</dt:businessEntity>
16 ···<dt:enterprise> dt:Enterprise [0..1] Данные о предприятии-производителе продукции
17 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор предприятия <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
18 ···</dt:enterprise>
19 </ws:getProductItemListRequest>

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

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

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

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

Запрос на получение первой записи списка наименований продукции без смещения.


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