GetPurposeList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 25: | Строка 25: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getPurposeListRequest> | |||
| | |||
| | |||
| | |||
|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;" |</ws:getPurposeListRequest> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Спецификация ответа== | ==Спецификация ответа== |
Версия 11:35, 30 октября 2017
Общие сведения
Операция GetPurposeList предназначена для получения списка актуальных записей о назначениях груза (active=true, last=true). Операция поддерживает постраничный вывод. Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка.
Выходные данные
- список актуальных записей назначений груза.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getPurposeListRequest> | ||||
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> | ||||
6 | </ws:getPurposeListRequest> |
Спецификация ответа
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трех назначений груза, со смещением равным двум.
Ответ на запрос.