GetRegionChangesList: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 59: | Строка 59: | ||
! Поле !! Описание !! Тип !! Обязательность | ! Поле !! Описание !! Тип !! Обязательность | ||
|- | |- | ||
| '''beginDate''' || Дата, начиная с которой пользователь получит историю изменений записей стран. || [[ | | '''beginDate''' || Дата, начиная с которой пользователь получит историю изменений записей стран. || [[Date|bs:Date]] || 1 | ||
|- | |- | ||
| '''endDate''' || Конец временного интервала. | | '''endDate''' || Конец временного интервала. | ||
* В случае, если компонента endDate не указана, то используется текущая дата. | * В случае, если компонента endDate не указана, то используется текущая дата. | ||
|| [[ | || [[Date|bs:Date]] || 0..1 | ||
|} | |} | ||
Версия 12:50, 19 октября 2016
Общие сведения
Метод позволяет получить историю изменений в списке регионов. Выполнение операции заканчивается возвратом списка регионов. В список попадают записи, дата изменения которых, попадает во временной интервал, указанный в запросе. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
Данные запроса
Объект getRegionChangesListRequest
Корневой объект запроса.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| listOptions | Параметры запрашиваемого списка | bs:ListOptions | 0..1 |
| updateDateInterval | Интервал дат | bs:DateInterval | 0..1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
| offset | Смещение в списке относительно начала | xs:nonNegativeInteger | 0..1 |
Объект ..Request/updateDateInterval
Объект содержит сведения об интервале времени, за который необходимо получить обновления.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| beginDate | Дата, начиная с которой пользователь получит историю изменений записей стран. | bs:Date | 1 |
| endDate | Конец временного интервала.
|
bs:Date | 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 |
| name | Название региона страны | xs:string | 1 |
| englishName | Название региона страны на английском языке | xs:string | 1 |
| view | Представление объекта (обычно это название + название типа объекта) | bs:String255 | 1 |
| type | Название типа адресного объекта (например, область, район или город) | bs:String255 | 1 |
| countryGuid | Глобальный идентификатор страны, к которой относится данный объект. | bs:UUID | 1 |
| hasStreets | Флаг, указывающий наличие улиц | xs:boolean | 1 |
