GetCountryChangesList

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

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

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

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


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

Объект 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

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

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

Данные ответа

Объект getCountryChangesListResponse

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

Поле Описание Тип данных Обязательность
countryList Объект, содержащий запрашиваемый список стран ikar:CountryList 1

Объект ..Response/countryList

Объект содержит список стран

Поле Описание Тип данных Обязательность
country Объект содержит информацию о стране ikar:Country 1

Объект ..Response/countryList/country

Объект содержит информацию о стране.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии записи о стране в реестре системы Икар. bs:UUID 1
GUID Глобальный идентификатор страны в реестре системы Икар. bs:UUID 1
active Флаг, указывающий активна ли запись. xs:boolean 1
last Флаг, указывающий, является ли версия записи последней. xs:boolean 1
status Статус записи. bs:VersionStatus 1
createDate Дата создания записи. xs:date 1
updateDate Дата обновления записи. xs:date 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
name Название страны (например, Белоруссия). xs:string 1
fullName Полное название страны (например, Республика Беларусь). xs:string 1
englishName Название страны на английском языке. xs:string 1
code Двухбуквенный код страны в соответствии со стандартом ISO 3166-1 alpha-2. xs:string 1
code3 Трёхбуквенный код страны в соответствии со стандартом ISO 3166-1 alpha-3. xs:string 1