GetDistrictListByRegion

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

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

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

xs (http://www.w3.org/2001/XMLSchema)

ikar (http://api.vetrf.ru/schema/cdm/ikar)
- ikar:CountryList
- ikar:Country

base (http://api.vetrf.ru/schema/cdm/base)

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

Объект getDistrictListByRegionRequest

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

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры возвращаемого списка: количество элементов и смещение	bs:ListOptions	0..1
regionGUID	Идентификатор региона	bs:DateInterval	0..1

Объект ..Request/listOptions

Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке По умолчанию значение равно 100; Максимально допустимое значение равно 1000	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала	xs:nonNegativeInteger	0..1

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

Объект getDistrictListByRegionResponse

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

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