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

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


==Спецификация запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание
! Пример
|-
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getSubProductByProductListRequest>
|
|
|
|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;" |···&lt;dt:productGuid
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор продукции
* второй уровень иерархического справочника продукции ИС Меркурий
|style="font-family: Courier;" |&lt;dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
|-
|7
|style="font-weight: bold; font-family: Courier;" |</ws:getSubProductByProductListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|}


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

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

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

Операция GetSubProductByProductList предназначена для получения списка видов продукции (3 уровень иерархического справочника), отфильтрованного по указанному продукту (2 уровень иерархического справочника). В список попадают только актуальные последние записи (active=true, last=true). Метод поддерживает возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка видов продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

  • параметры выводимого списка.
  • идентификатор продукта (2 уровень иерархического справочника)

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

  • данные запрошенного вида продукции (3 уровень иерархического справочника).

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getSubProductByProductListRequest>
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 ···<dt:productGuid bs:UUID [1..1] Глобальный идентификатор продукции
  • второй уровень иерархического справочника продукции ИС Меркурий
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
7 </ws:getSubProductByProductListRequest>

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

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

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

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

Запрос данных 3 видов продукции со смещением 2 от начала списка.


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