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

Версия 12:44, 1 ноября 2016

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

Операция FindLocalityListByName предназанчена для получения информации о населённом пункте или населённых пунктах, подчинённых региону, по названию этого пункта или его части. В список попадают только активные записи населённых пунктов (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)

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

Объект findLocalityListByNameRequest

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

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

Объект ..Request/listOptions

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

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

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

Объект findLocalityListByNameResponse

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

Поле	Описание	Тип данных	Обязательность
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:findLocalityListByNameRequest>
     <base:listOptions>
       <base:count>3</base:count>
       <base:offset>0</base:offset>
     </base:listOptions>
     <ikar:regionGuid>6fdecb78-893a-4e3f-a5ba-aa062459463b</ikar:regionGuid>
     <ws:pattern>Ка</ws:pattern>
   </ws:findLocalityListByNameRequest>
 </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:findLocalityListByNameResponse 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="9" offset="0">    
       <ikar:locality>
         <bs:uuid>a1220931-ff14-4923-9d22-0d1acda1a1ea</bs:uuid>
         <bs:guid>4b47898d-6fa1-4b6a-b6ff-3f5fa5a95321</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>2015-06-29T00:00:00+03:00</bs:createDate>
         <bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
         <bs:previous>608fdf98-024e-4fe9-8555-9e72282aeb61</bs:previous>
         <ikar:name>Андреевка</ikar:name>
         <ikar:view>с. Андреевка</ikar:view>
         <ikar:regionCode>92</ikar:regionCode>
         <ikar:type>с.</ikar:type>
         <ikar:hasStreets>true</ikar:hasStreets>
         <ikar:regionGuid>6fdecb78-893a-4e3f-a5ba-aa062459463b</ikar:regionGuid>
       </ikar:locality>
       <ikar:locality>
         <bs:uuid>7485d144-4ccc-47a5-9ffc-ad5b88577891</bs:uuid>
         <bs:guid>f7f48953-6fc5-4ed6-8ca9-4d7f6c370a2f</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>2015-07-01T00:00:00+03:00</bs:createDate>
         <bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
         <bs:previous>4e214b95-ebf4-44dc-9a0b-bcbd429f6865</bs:previous>
         <ikar:name>Камышлы</ikar:name>
         <ikar:view>с. Камышлы</ikar:view>
         <ikar:regionCode>92</ikar:regionCode>
         <ikar:type>с.</ikar:type>
         <ikar:hasStreets>true</ikar:hasStreets>
         <ikar:regionGuid>6fdecb78-893a-4e3f-a5ba-aa062459463b</ikar:regionGuid>
       </ikar:locality>
       <ikar:locality>
         <bs:uuid>1d162071-49ee-4860-8a83-6c055ac1acb2</bs:uuid>
         <bs:guid>862a5463-d58c-4539-a906-46007f4a925d</bs:guid>
         <bs:active>true</bs:active>
         <bs:last>true</bs:last>
         <bs:status>100</bs:status>
         <bs:createDate>2015-06-29T00:00:00+03:00</bs:createDate>
         <bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
         <bs:previous>77b08d1e-35af-408e-a5f3-7885ae9aa449</bs:previous>
         <ikar:name>Кача</ikar:name>
         <ikar:view>пгт. Кача</ikar:view>
         <ikar:regionCode>92</ikar:regionCode>
         <ikar:type>пгт.</ikar:type>
         <ikar:hasStreets>true</ikar:hasStreets>
         <ikar:regionGuid>6fdecb78-893a-4e3f-a5ba-aa062459463b</ikar:regionGuid>
       </ikar:locality>
     </ikar:localityList>
   </ws:findLocalityListByNameResponse>
 </SOAP-ENV:Body>