GetPurposeChangesList
Общие сведения
Операция GetPurposeChangesList предназначена для получения списка изменённых назначений груза за период времени. В список попадают записи, дата изменения которых попадает в интервал, указанный в запросе. Записи в списке могут быть не последними и/или не актуальными (last=false, active=false). Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
|
|
Входные данные
- параметры выводимого списка;
- интервал дат, за за который запрашиваются изменения.
Выходные данные
- список назначений груза за указанный период времени.
Данные запроса
Объект getPurposeChangesListRequest
Корневой объект запроса. В нём указаны параметры запрашиваемого списка и интервал дат, за который запрашиваются изменения.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры запрашиваемого списка. | bs:ListOptions | 0..1 |
updateDateInterval | Интервал дат, за которые требуется получить изменения. | bs:DateInterval | 1 |
Объект ..Request/listOptions
Объект содержит в себе параметры запрашиваемого списка.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке.
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Объект ..Request/updateDateInterval
Объект содержит сведения об интервале времени, за который необходимо получить обновления.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
beginDate | Дата, начиная с которой пользователь получит историю изменений записей. | xs:dateTime | 1 |
endDate | Конец временного интервала.
|
xs:dateTime | 0..1 |
Данные ответа
Объект getPurposeChangesListResponse
Корневой элемент ответа. Содержит информацию о списке изменённых целей.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
purposeList | Сущность, описывающая список назначений груза. | argc:PurposeList | 1 |
Объект ..Response/purposeList
Содержит в себе объекты, описывающие назначение перемещения груза.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
purpose | Сущность, описывающая назначение груза. | argc:Purpose | 1 |
Атрибуты списка purposeList
Атрибут | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество элементов списка, запрашиваемое или переданное. | xs:int | 1 |
total | Общий размер списка. | xs:long | 1 |
offset | Смещение первого элемента списка относительно его начала. | xs:int | 1 |
Объект ..Response/purposeList/purpose
Объект содержит данные о назначении груза.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
UUID | Идентификатор версии записи о назначении груза в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор назначения груза в реестре Россельхознадзора. | bs:UUID | 1 |
active | Флаг, указывающий на то, активна ли запись. | xs:boolean | 1 |
last | Флаг, указывающий на то, является ли запись последней. | xs:boolean | 1 |
status | Статус версии записи. | xs:string | 1 |
createDate | Дата создания записи о назначении груза в реестре Россельхознадзора. | xs:dateTime | 1 |
updateDate | Дата последнего обновления записи в реестре Россельхознадзора. | xs:dateTime | 1 |
previous | Идентификатор предыдущей версии записи. | bs:UUID | 0..1 |
next | Идентификатор следующей версии записи. | bs:UUID | 0..1 |
name | Название цели (назначения груза). | xs:string | 0..1 |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос списка назначений груза, измененных за период с 01.01.2016 по текущий день.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"
xmlns:base="http://api.vetrf.ru/schema/cdm/base">
<soapenv:Header/>
<soapenv:Body>
<ws:getPurposeChangesListRequest>
<base:listOptions>
<base:count>100</base:count>
<base:offset>0</base:offset>
</base:listOptions>
<base:updateDateInterval>
<base:beginDate>2016-01-01T00:00:00</base:beginDate>
</base:updateDateInterval>
</ws:getPurposeChangesListRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<ws:getPurposeChangesListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
<com:purposeList count="1" total="1" offset="0">
<com:purpose>
<bs:uuid>4715480a-4f1f-291d-adea-c4063de4704c</bs:uuid>
<bs:guid>b5734ab1-c5d2-bff3-c102-0b1c8b11a004</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2016-09-08T17:49:38+03:00</bs:createDate>
<bs:updateDate>2016-09-08T17:49:38+03:00</bs:updateDate>
<com:name>оформление справки о безопасности сырого молока</com:name>
</com:purpose>
</com:purposeList>
</ws:getPurposeChangesListResponse>
</S:Body>
</soapenv:Envelope>