|
|
Строка 51: |
Строка 51: |
| |} | | |} |
|
| |
|
| ===Объект [[#Объект getRegionChangesList|..Request]]/updateDateInterval=== | | ===Объект [[#Объект getRegionChangesListRequest|..Request]]/updateDateInterval=== |
|
| |
|
| Объект содержит сведения об интервале времени, за который необходимо получить обновления. | | Объект содержит сведения об интервале времени, за который необходимо получить обновления. |
Версия 15:10, 6 сентября 2016
Общие сведения
Метод позволяет получить историю изменений в списке регионов. Выполнение операции заканчивается возвратом списка регионов. В список попадают записи, дата изменения которых, попадает во временной интервал, указанный в запросе. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
- xs (http://www.w3.org/2001/XMLSchema)
|
- ikar (http://api.vetrf.ru/schema/cdm/ikar)
- base (http://api.vetrf.ru/schema/cdm/base)
|
Данные запроса
Объект getRegionChangesListRequest
Корневой объект запроса.
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
Поле |
Описание |
Тип данных |
Обязательность
|
count |
Количество значений в списке
- По умолчанию значение равно 100;
- Максимально допустимое значение равно 1000
|
xs:nonNegativeInteger |
0..1
|
offset |
Смещение в списке относительно начала |
xs:nonNegativeInteger |
0..1
|
Объект ..Request/updateDateInterval
Объект содержит сведения об интервале времени, за который необходимо получить обновления.
Поле |
Описание |
Тип |
Обязательность
|
beginDate |
Дата, начиная с которой пользователь получит историю изменений записей стран. |
bs:DataInterval |
1
|
endDate |
Конец временного интервала.
- В случае, если компонента endDate не указана, то используется текущая дата.
|
bs:DataInterval |
0..1
|
Данные ответа
Объект getRegionChangesListResponse
Корневой объект ответа. Содержит информацию о списке регионов указанной страны.
Объект, содержащий список регионов.
Поле |
Описание |
Тип данных |
Обязательность
|
region |
Объект, описывающий регион |
ikar:Region |
1
|
Объект, описывающий регион.
Поле |
Описание |
Тип данных |
Обязательность
|
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
|
name |
Название региона страны |
xs:string |
1
|
englishName |
Название региона страны на английском языке |
xs:string |
1
|
view |
Представление объекта (обычно это название + название типа объекта) |
bs:String255 |
1
|
type |
Название типа адресного объекта (например, область, район или город) |
bs:String255 |
1
|
countryGuid |
Глобальный идентификатор страны, к которой относится данный объект. |
bs:UUID |
1
|
hasStreets |
Флаг, указывающий наличие улиц |
xs:boolean |
1
|