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

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


==Спецификация запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание
! Пример
|-
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getProductItemListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|2
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
|[[ListOptions|bs:ListOptions]]
|[0..1]
|Параметры запрашиваемого списка.
|style="font-family: Courier;" |
|-
|3
|style="font-weight: bold; font-family: Courier;" |······<bs:count>
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|Максимальное запрашиваемое количество объектов в списке.
* По умолчанию значение 100;
* Максимально возможное значение 1000.
|style="font-family: Courier;" |<bs:count>10</bs:count>
|-
|4
|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|Номер элемента, по которому осуществляется смещение первого элемента списка.
* По умолчанию значение 0.
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
|-
|5
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
|
|
|
|style="font-family: Courier;" |
|-
|6
|style="font-weight: bold; font-family: Courier;" |···<vd:productType>
|[[ProductType_v2.0|dt:ProductType]]
|[0..1]
|Тип продукции. Первый уровень иерархического справочника продукции ИС Меркурий.
|style="font-family: Courier;" |<vd:productType>1</vd:productType>
|-
|7
|style="font-weight: bold; font-family: Courier;" |···<vd:product>
|[[Product_v2.0|dt:Product]]
|[0..1]
|Продукция. Второй уровень иерархического справочника продукции ИС Меркурий.
|style="font-family: Courier;" |
|-
|8
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|[[UUID|bs:UUID]]
|[1..1]
|Идентификатор версии продукции.
|style="font-family: Courier;" |<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
|-
|9
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор продукции.
|style="font-family: Courier;" |<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
|-
|10
|style="font-weight: bold; font-family: Courier;" |···</vd:product>
|
|
|
|style="font-family: Courier;" |
|-
|11
|style="font-weight: bold; font-family: Courier;" |···<vd:subProduct>
|[[SubProduct_v2.0|dt:SubProduct]]
|[0..1]
|Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.
|style="font-family: Courier;" |
|-
|12
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|[[UUID|bs:UUID]]
|[1..1]
|Идентификатор версии вида продукции.
|style="font-family: Courier;" |<bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid>
|-
|13
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор вида продукции.
|style="font-family: Courier;" |<bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
|-
|14
|style="font-weight: bold; font-family: Courier;" |···</vd:subProduct>
|
|
|
|style="font-family: Courier;" |
|-
|15
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:businessEntity>
|[[BusinessEntity_v2.0|dt:BusinessEntity]]
|[0..1]
|Данные о хозяйствующем субъекте.
|style="font-family: Courier;" |
|-
|16
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|[[UUID|bs:UUID]]
|[0..1]
|Идентификатор версии хозяйствующего субъекта.
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|17
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[0..1]
|Глобальный идентификатор хозяйствующего субъекта.
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
|-
|18
|style="font-weight: bold; font-family: Courier;" |···</dt:businessEntity>
|
|
|
|style="font-family: Courier;" |
|-
|19
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:enterprise>
|[[Enterprise_v2.0|dt:Enterprise]]
|[0..1]
|Данные о предприятии-производителе продукции
|style="font-family: Courier;" |
|-
|20
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|[[UUID|bs:UUID]]
|[0..1]
|Идентификатор версии предприятия
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|21
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[0..1]
|Глобальный идентификатор предприятия
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
|-
|22
|style="font-weight: bold; font-family: Courier;" |···</dt:enterprise>
|
|
|
|style="font-family: Courier;" |
|-
|23
|style="font-weight: bold; font-family: Courier;" |</ws:getProductItemListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|}


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

Версия 23:21, 29 октября 2017

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

Операция 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:uuid> bs:UUID [1..1] Идентификатор версии продукции. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
9 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор продукции. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
10 ···</vd:product>
11 ···<vd:subProduct> dt:SubProduct [0..1] Вид продукции. Третий уровень иерархического справочника продукции ИС Меркурий.
12 ······<bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукции. <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid>
13 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции. <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
14 ···</vd:subProduct>
15 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте.
16 ······<bs:uuid> bs:UUID [0..1] Идентификатор версии хозяйствующего субъекта. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
17 ······<bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
18 ···</dt:businessEntity>
19 ···<dt:enterprise> dt:Enterprise [0..1] Данные о предприятии-производителе продукции
20 ······<bs:uuid> bs:UUID [0..1] Идентификатор версии предприятия <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
21 ······<bs:guid> bs:UUID [0..1] Глобальный идентификатор предприятия <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
22 ···</dt:enterprise>
23 </ws:getProductItemListRequest>

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

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

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

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

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


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

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