GetPurposeChangesList v2.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 112: Строка 112:


==Спецификация ответа==
==Спецификация ответа==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание
! Пример
|-
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getPurposeChangesListResponse>
|
|
|
|style="font-family: Courier;" |
|-
|2
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:purposeList count="100" total="115" offset="0">
|[[PurposeList_v2.0|dt:PurposeList]]
|[1..1]
|Список целей
* total - всего записей;
* offset - смещение относительно первого элемента;
* count - количество выводимых записей.
|style="font-family: Courier;" |
|-
|3
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:purpose>
|[[Purpose_v2.0|dt:Purpose]]
|[0..*]
|Цель
|style="font-family: Courier;" |
|-
|4
|style="font-weight: bold; font-family: Courier;" |·········<bs:uuid>
|[[UUID|bs:UUID]]
|[1..1]
|Идентификатор версии цели
|style="font-family: Courier;" |<bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
|-
|5
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор цели
|style="font-family: Courier;" |<bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid>
|-
|6
|style="font-weight: bold; font-family: Courier;" |·········<bs:active>
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|Является ли запись активной:
* true - запись активна;
* false - запись не активна.
|style="font-family: Courier;" |<bs:active>true</bs:active>
|-
|7
|style="font-weight: bold; font-family: Courier;" |·········<bs:last>
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|Является ли версия записи последней:
* true - да;
* false - нет.
|style="font-family: Courier;" |<bs:last>true</bs:last>
|-
|8
|style="font-weight: bold; font-family: Courier;" |·········<bs:status>
|[[VersionStatus|bs:VersionStatus]]
|[1..1]
|Статус версии цели
|style="font-family: Courier;" |<bs:status>100</bs:status>
|-
|9
|style="font-weight: bold; font-family: Courier;" |·········<bs:createDate>
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
|Дата создания цели
|style="font-family: Courier;" |<bs:createDate>2017-07-07T12:00:00</bs:createDate>
|-
|10
|style="font-weight: bold; font-family: Courier;" |·········<bs:updateDate>
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
|Дата изменения цели.
|style="font-family: Courier;" |<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
|-
|11
|style="font-weight: bold; font-family: Courier;" |·········<bs:previous>
|[[UUID|bs:UUID]]
|[0..1]
|Идентификатор предыдущей версии записи реестра целей
|style="font-family: Courier;" |<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
|-
|12
|style="font-weight: bold; font-family: Courier;" |·········<bs:next>
|[[UUID|bs:UUID]]
|[0..1]
|Идентификатор следующей версии записи реестра целей.
|style="font-family: Courier;" |<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
|-
|13
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:name>
|[[String255|bs:String255]]
|[1..1]
|Наименование цели
|style="font-family: Courier;" |&lt;dt:name>в корм животным</dt:name>
|-
|14
|style="font-weight: bold; font-family: Courier;" |······</dt:purpose>
|
|
|
|style="font-family: Courier;" |
|-
|15
|style="font-weight: bold; font-family: Courier;" |···</dt:purposeList>
|
|
|
|style="font-family: Courier;" |
|-
|16
|style="font-weight: bold; font-family: Courier;" |</ws:getPurposeChangesListResponse>
|
|
|
|style="font-family: Courier;" |
|-
|}


==Описание ошибок==
==Описание ошибок==

Версия 10:09, 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] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
 <bs:count>10</bs:count>
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
 <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>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getPurposeChangesListResponse>
2 ···<dt:purposeList count="100" total="115" offset="0"> dt:PurposeList [1..1] Список целей
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
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] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
7 ·········<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <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:getPurposeChangesListResponse>

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

Пример запроса

Запрос списка назначений груза, измененных за период с 01.01.2016 по текущий день.


Ответ на запрос.

Источник — http://help.vetrf.ru/index.php?title=GetPurposeChangesList_v2.0&oldid=22322