GetProductByTypeList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 28: | Строка 28: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getProductByTypeListRequest> | |||
| | |||
| | |||
| | |||
|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;" | | |||
|- | |||
|2 | |||
|style="font-weight: bold; font-family: Courier;" |···<dt:productType> | |||
|[[ProductType_v2.0|dt:ProductType]] | |||
|[1..1] | |||
|Тип продукции | |||
* первый уровень иерархического справочника продукции ИС Меркурий | |||
|style="font-family: Courier;" |<dt:productType>5</dt:productType> | |||
|- | |||
|3 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getProductByTypeListRequest> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Спецификация ответа== | ==Спецификация ответа== |
Версия 23:03, 29 октября 2017
Общие сведения
Операция GetProductByTypeList предназначена для получения списка продукции по указанному типу. Тип продукции указан номером, посмотреть его можно здесь. Выполнение операции заканчивается либо возвратом списка продукции(active = true, last = true), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- тип продукции (1 уровень иерархического справочника).
Выходные данные
- список продукции (2 уровень иерархического справочника).
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getProductByTypeListRequest> | ||||
2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<bs:offset>2</bs:offset> |
5 | ···</bs:listOptions> | ||||
2 | ···<dt:productType> | dt:ProductType | [1..1] | Тип продукции
|
<dt:productType>5</dt:productType> |
3 | </ws:getProductByTypeListRequest> |
Спецификация ответа
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трёх элементов списка "Пищевые продукты" без смещения.
Ответ на запрос.