GetPurposeList v2.0
Общие сведения
Операция 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> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getPurposeListResponse> | ||||
| 2 | ···<dt:purposeList count="100" total="115" offset="0"> | dt:PurposeList | [1..1] | Список целей
|
|
| 3 | ······<dt:purpose> | dt:Purpose | [0..*] | Цель | |
| 4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии цели | <bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid> |
| 5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор цели | <bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid> |
| 6 | ·········<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
| 7 | ·········<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
| 8 | ·········<bs:status> | bs:VersionStatus | [1..1] | Статус версии цели | <bs:status>100</bs:status> |
| 9 | ·········<bs:createDate> | xs:DateTime | [1..1] | Дата создания цели | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
| 10 | ·········<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения цели. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
| 11 | ·········<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи реестра целей | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
| 12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи реестра целей. | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
| 13 | ·········<dt:name> | bs:String255 | [1..1] | Наименование цели | <dt:name>в корм животным</dt:name> |
| 14 | ······</dt:purpose> | ||||
| 15 | ···</dt:purposeList> | ||||
| 16 | </ws:getPurposeListResponse> |
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трех назначений груза, со смещением равным двум.
Ответ на запрос.
