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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 46: Строка 46:
| '''count''' || Количество значений в списке
| '''count''' || Количество значений в списке
* По умолчанию значение равно 100;
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000  
* Максимально допустимое значение равно 1000.
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|| [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
| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
|-
|}
|}

Версия 16:14, 31 октября 2016

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

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

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

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

Объект getRegionChangesListRequest

Корневой объект запроса.

Поле Описание Тип данных Обязательность
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

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

Объект getRegionChangesListResponse

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

Поле Описание Тип данных Обязательность
regionList Список регионов ikar:RegionList 1


Объект ..Response/regionList

Объект, содержащий список регионов.

Поле Описание Тип данных Обязательность
region Объект, описывающий регион ikar:Region 1

Объект ..Response/regionList/region

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

Поле Описание Тип данных Обязательность
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
englishName Название региона на английском языке. xs:string 0..1
view Представление объекта (обычно это название + название типа объекта).
  • Например: Владимирская обл.
bs:String255 1
regionCode Код региона
  • Например: 33 (код Владимирской области).
xs:string 0..1
type Название типа адресного объекта (например, область, район или город).
  • Например: обл.
bs:String255 1
countryGuid Глобальный идентификатор страны, к которой относится данный объект. bs:UUID 1
hasStreets Флаг, указывающий наличие улиц. xs:boolean 1