GetLocalityListByRegion: различия между версиями

Версия 13:04, 1 декабря 2016

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

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

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

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

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

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

Входные данные

параметры выводимого списка.

Выходные данные

список записей населённых пунктов, относящихся к указанному региону, актуальных и последних (active=true, last=true).

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

Объект 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	0..*

Атрибуты списка 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

Описание ошибок

Ошибка	Описание
InternalServiceFault	Внутренняя ошибка сервиса.
IncorrectRequestFault	Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.
EntityNotFoundFault	Ошибка, свидетельствующая о том, что регион с указанным глобальным идентификатором не найден.

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

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

<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>3</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>

Ответ на запрос.

 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
 <SOAP-ENV:Body xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <ws:getLocalityListByRegionResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                       xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar" 
                                       xmlns:ws="http://api.vetrf.ru/schema/cdm/ikar/ws-definitions">
     <ikar:localityList count="3" total="30" offset="0">
       <ikar:locality>
         <bs:uuid>bee40741-8eba-461f-870a-ab1c2ab70c26</bs:uuid>
         <bs:guid>fd4781dc-f33b-4ccc-bd10-7f20b3385a7f</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
         <bs:updateDate>2015-09-16T00:00:00+03:00</bs:updateDate>
         <ikar:name>Александровская</ikar:name>
         <ikar:view>п. Александровская</ikar:view>
         <ikar:regionCode>78</ikar:regionCode>
         <ikar:type>п.</ikar:type>
         <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
         <ikar:hasStreets>true</ikar:hasStreets>
       </ikar:locality>
       <ikar:locality>
         <bs:uuid>a1e83708-f10f-4378-9ba0-9c9aaa4c30ab</bs:uuid>
         <bs:guid>70b619a5-0aaa-46ae-a56f-b65132fa20c2</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
         <bs:updateDate>2011-09-14T00:00:00+04:00</bs:updateDate>
         <ikar:name>Белоостров</ikar:name>
         <ikar:view>п. Белоостров</ikar:view>
         <ikar:regionCode>78</ikar:regionCode>
         <ikar:type>п.</ikar:type>
         <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
         <ikar:hasStreets>true</ikar:hasStreets>
       </ikar:locality>
       <ikar:locality>
         <bs:uuid>be4a461e-7ef1-47a5-bd3a-0c5bd9ec8bca</bs:uuid>
         <bs:guid>ac598324-b704-4957-a66e-e8142677981b</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
         <bs:updateDate>2015-05-09T00:00:00+03:00</bs:updateDate>
         <ikar:name>Зеленогорск</ikar:name>
         <ikar:view>г. Зеленогорск</ikar:view>
         <ikar:regionCode>78</ikar:regionCode>
         <ikar:type>г.</ikar:type>
         <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
         <ikar:hasStreets>true</ikar:hasStreets>
       </ikar:locality>
     </ikar:localityList>
   </ws:getLocalityListByRegionResponse>
 </SOAP-ENV:Body>