GetPurposeChangesList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetPurposeChangesList''' предназначена для получения списка изменённы…») |
|||
| Строка 28: | Строка 28: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getPurposeChangesListRequest> | |||
| | |||
| | |||
| | |||
|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;" |···<bs:updateDateInterval> | |||
|[[DataInterval|bs:DataInterval]] | |||
|[1..1] | |||
|Интервал времени обновления. В список попадают все записи, дата обновлений которых попадает в указанный интервал. | |||
|style="font-family: Courier;" | | |||
|- | |||
|7 | |||
|style="font-weight: bold; font-family: Courier;" |······<bs:beginDate> | |||
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] | |||
|[1..1] | |||
|Начало временного интервала. | |||
|style="font-family: Courier;" |<bs:beginDate>2017-07-07T00:00:00</bs:beginDate> | |||
|- | |||
|8 | |||
|style="font-weight: bold; font-family: Courier;" |······<bs:endDate> | |||
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] | |||
|[1..1] | |||
|Конец временного интервала. | |||
|style="font-family: Courier;" |<bs:endDate>2017-07-25T00:00:00</bs:endDate> | |||
|- | |||
|9 | |||
|style="font-weight: bold; font-family: Courier;" |···</bs:updateDateInterval> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|10 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getPurposeChangesListRequest> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Спецификация ответа== | ==Спецификация ответа== | ||
Версия 10:08, 30 октября 2017
Общие сведения
Операция GetPurposeChangesList предназначена для получения списка изменённых записей о назначениях груза за период времени. В список попадают записи, дата изменения которых попадает в интервал, указанный в запросе. Записи в списке могут быть не последними и/или не актуальными (last=false, active=false). Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- интервал дат, за за который запрашиваются изменения.
Выходные данные
- список назначений груза за указанный период времени.
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getPurposeChangesListRequest> | ||||
| 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 | ···<bs:updateDateInterval> | bs:DataInterval | [1..1] | Интервал времени обновления. В список попадают все записи, дата обновлений которых попадает в указанный интервал. | |
| 7 | ······<bs:beginDate> | xs:dateTime | [1..1] | Начало временного интервала. | <bs:beginDate>2017-07-07T00:00:00</bs:beginDate> |
| 8 | ······<bs:endDate> | xs:dateTime | [1..1] | Конец временного интервала. | <bs:endDate>2017-07-25T00:00:00</bs:endDate> |
| 9 | ···</bs:updateDateInterval> | ||||
| 10 | </ws:getPurposeChangesListRequest> |
Спецификация ответа
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос списка назначений груза, измененных за период с 01.01.2016 по текущий день.
Ответ на запрос.
