GetLocalityListByRegion

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

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

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

xs (http://www.w3.org/2001/XMLSchema) xs:boolean xs:dateTime xs:string xs:nonNegativeInteger

ikar (http://api.vetrf.ru/schema/cdm/ikar) ikar:LocalityList ikar:Locality

base (http://api.vetrf.ru/schema/cdm/base) bs:UUID bs:VersionStatus bs:ListOptions bs:String255

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

Объект getLocalityListByRegionRequest

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

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

Объект ..Request/listOptions

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

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

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

Объект getLocalityListByRegionResponse

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

Поле	Описание	Тип данных	Обязательность
localityList	Объект содержит список районов.	ikar:LocalityList	1

Объект ..Response/localityList

Объект содержит список населённых пунктов, подчинённых региону.

Поле	Описание	Тип данных	Обязательность
locality	Данные населённого пункта.	ikar:Locality	1..*

Атрибуты списка localityList

Атрибут	Описание	Тип данных	Обязательность
count	Количество элементов списка, запрашиваемое или переданное.	xs:int	1
total	Общий размер списка.	xs:long	1
offset	Смещение первого элемента списка относительно его начала.	xs:int	1

Объект ..Response/localityList/locality

Объект содержит информацию о населенном пункте.

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

Пример запроса

Запрос списка населённых пунктов г. Санкт-Петербург (как региона). Ответ будет содержать не только посёлки, но и подчинённые города.

<codeblock language="xml" class = "mw-collapsible"> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"

                 xmlns:ws="http://api.vetrf.ru/schema/cdm/ikar/ws-definitions" 
                 xmlns:base="http://api.vetrf.ru/schema/cdm/base" 
                 xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
 <soapenv:Header/>
 <soapenv:Body>
   <ws:getLocalityListByRegionRequest>
     <base:listOptions>
       <base:count>100</base:count>
       <base:offset>0</base:offset>
     </base:listOptions>
     <ikar:regionGuid>c2deb16a-0330-4f05-821f-1d09c93331e6</ikar:regionGuid>
   </ws:getLocalityListByRegionRequest>
 </soapenv:Body>

</soapenv:Envelope> </syntaxhighlight>