GetCountryChangesList: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Метод позволяет получить историю изменений в списке стран. Выполнение…»)
 
Строка 23: Строка 23:
** [[VersionStatus|bs:VersionStatus]]
** [[VersionStatus|bs:VersionStatus]]
{{столбцы/конец}}
{{столбцы/конец}}
==Данные запроса==
===Объект getCountryChangesList===
Корневой объект запроса. Содержит параметры запрашиваемого списка.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры возвращаемого списка: количество элементов и смещение || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateinterval''']] || Интервал дат, за который запрашиваются изменения || [[DateInterval|bs:DateInterval]] || 0..1
|}
===Объект [[#Объект getCountryChangesList|..Request]]/listOptions===
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''count''' || Количество значений в списке
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
|}
===Объект [[#Объект getCountryChangesList|..Request]]/updateDateInterval===
=== Объект [[#Объект getStockEntryChangesListRequest|..Request]]/'''updateDateInterval'''===
Объект содержит сведения об интервале времени, за который необходимо получить обновления.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''beginDate''' || Дата, начиная с которой пользователь получит историю изменений записей стран. || [[dataInterval|bs:DataInterval]] || 1
|-
| '''endDate''' || Конец временного интервала.
* В случае, если компонента endDate не указана, то используется текущая дата.
|| [[dataInterval|bs:DataInterval]] || 0..1
|}

Версия 23:12, 28 августа 2016

Общие сведения

Метод позволяет получить историю изменений в списке стран. Выполнение операции заканчивается возвратом списка стран. В список попадают записи, дата изменения которых попадает во временной интервал, указанный в запросе. Метод поддерживает возможность частичного вывода списка.

Используемые пространства имён и типы


Данные запроса

Объект getCountryChangesList

Корневой объект запроса. Содержит параметры запрашиваемого списка.

Поле Описание Тип данных Обязательность
listOptions Параметры возвращаемого списка: количество элементов и смещение bs:ListOptions 0..1
updateDateinterval Интервал дат, за который запрашиваются изменения bs:DateInterval 0..1

Объект ..Request/listOptions

Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.

Поле Описание Тип данных Обязательность
count Количество значений в списке
  • По умолчанию значение равно 100;
  • Максимально допустимое значение равно 1000
xs:nonNegativeInteger 0..1
offset Смещение в списке относительно начала xs:nonNegativeInteger 0..1

Объект ..Request/updateDateInterval

Объект ..Request/updateDateInterval

Объект содержит сведения об интервале времени, за который необходимо получить обновления.

Поле Описание Тип Обязательность
beginDate Дата, начиная с которой пользователь получит историю изменений записей стран. bs:DataInterval 1
endDate Конец временного интервала.
  • В случае, если компонента endDate не указана, то используется текущая дата.
bs:DataInterval 0..1