GetDistrictChangesList
Версия от 15:45, 6 сентября 2016; Egorova-iv-150707 (обсуждение | вклад) (Новая страница: «==Общие сведения== Метод позволяет получить историю изменений в списке районов. Выполнен…»)
Общие сведения
Метод позволяет получить историю изменений в списке районов. Выполнение операции заканчивается возвратом списка районов. В список попадают записи, дата изменения которых, попадает во временной интервал, указанный в запросе. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
Данные запроса
Объект getDistrictChangesListRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
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:DataInterval | 1 |
endDate | Конец временного интервала.
|
bs:DataInterval | 0..1 |
Данные ответа
Объект getDistrictChangesListResponse
Корневой объект ответа. Содержит список изменённых районов за указанный период времени.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
districtList | Список районов | ikar:DistrictList | 1 |
Объект ..Response/districtList
Объект содержит сущности, описывающие районы.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
district | Объект, описывающий район | ikar:District | 1 |
Объект ..Response/districtList/district
Объект, содержащий данные о районе.
Поле | Описание | Текст заголовка | Текст заголовка |
---|---|---|---|
UUID | Уникальный идентификатор версии записи | bs:UUID | 1 |
GUID | Глобальный уникальный идентификатор записи | bs:UUID | 1 |
active | Флаг, указывающий активна ли запись | xs:boolean | 1 |
previous | Флаг, указывающий наличие предыдущей записи | xs:boolean | 1 |
last | Флаг, указывающий, является ли версия записи последней | xs:boolean | 1 |
status | Статус записи | bs:VersionStatus | 1 |
createDate | Дата создания записи | xs:date | 1 |
updateDate | Дата обновления записи | xs:date | 1 |
name | Название региона страны | xs:string | 1 |
view | Представление объекта. Обычно это название + тип | bs:String255 | 1 |
regionCode | Глобальный идентификатор региона | bs:UUID | 1 |
type | Название адресного типа | bs:String255 | 1 |
countryGuid | Глобальный идентификатор страны | bs:UUID | 1 |
hasStreets | Флаг, указывающий на наличие улиц | xs:boolean | 1 |
regionGuid | Глобальный идентификатор региона, которому принадлежит район | bs:UUID | 1 |