FindLocalityListByName
Общие сведения
Операция FindLocalityListByName предназначена для получения информации о населённом пункте или населённых пунктах, подчинённых региону, по названию этого пункта или его части. В список попадают только активные записи населённых пунктов (active=true, last= true), у которых глобальный идентификатор региона равен запрошенному. Выполнение операции заканчивается либо возвратом списка населенных пунктов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Входные данные
- параметры выводимого списка
- шаблон названия населённого пункта
- глобальный идентификатор региона
Выходные данные
- список записей населённых, актуальных и последних (active=true, last=true).
Данные запроса
Объект findLocalityListByNameRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка, название населённого пункта или его часть и идентификатор региона.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры возвращаемого списка: количество элементов и смещение. | bs:ListOptions | 0..1 |
regionGuid | Глобальный идентификатор региона. | bs:UUID | 1 |
pattern | Часть названия или название населённого пункта. | bs:String255 | 1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект findLocalityListByNameResponse
Корневой объект ответа.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
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 | Код региона
|
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: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>
Ответ на запрос.
<codeblock language="xml" class = "mw-collapsible"> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<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>
</soapenv:Envelope> </syntaxhighlight>
Запрос списка из двух населённых пунктов, подчинённых Владимирской области, в названии которых встречается "исово". Смещение равно единице.
<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>2</base:count> <base:offset>1</base:offset> </base:listOptions> <ikar:regionGuid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</ikar:regionGuid> <ws:pattern>исово</ws:pattern> </ws:findLocalityListByNameRequest> </soapenv:Body>
</soapenv:Envelope> </syntaxhighlight>
Ответ на запрос.
<codeblock language="xml" class = "mw-collapsible"> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<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="2" total="9" offset="1"> <ikar:locality> <bs:uuid>84f06501-0d38-42b5-be11-0fa549437e08</bs:uuid> <bs:guid>ec19d08f-4947-44cd-81a7-243a6fe01813</bs:guid> <bs:active>true</bs:active> <bs:last>true</bs:last> <bs:status>100</bs:status> <bs:createDate>2014-01-04T00:00:00+04:00</bs:createDate> <bs:updateDate>2014-09-11T00:00:00+04:00</bs:updateDate> <bs:previous>5202931c-196e-4539-ad53-9027a880ccaa</bs:previous> <ikar:name>Большое Филисово</ikar:name> <ikar:view>д. Большое Филисово</ikar:view> <ikar:regionCode>33</ikar:regionCode> <ikar:type>д.</ikar:type> <ikar:hasStreets>true</ikar:hasStreets> <ikar:regionGuid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</ikar:regionGuid> <ikar:districtGuid>05cd13b8-d0f3-4802-a31e-037ff8d1f24f</ikar:districtGuid> </ikar:locality> <ikar:locality> <bs:uuid>8aa285c1-f8f0-4cf5-b792-ec561dca9e98</bs:uuid> <bs:guid>bd8b0c53-0494-4602-b872-83714e7f61fb</bs:guid> <bs:active>true</bs:active> <bs:last>true</bs:last> <bs:status>100</bs:status> <bs:createDate>2014-01-04T00:00:00+04:00</bs:createDate> <bs:updateDate>2014-09-11T00:00:00+04:00</bs:updateDate> <bs:previous>0d501c07-6ae0-40eb-ac00-3fdec1318484</bs:previous> <ikar:name>Борисово</ikar:name> <ikar:view>с. Борисово</ikar:view> <ikar:regionCode>33</ikar:regionCode> <ikar:type>с.</ikar:type> <ikar:hasStreets>true</ikar:hasStreets> <ikar:regionGuid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</ikar:regionGuid> <ikar:districtGuid>e92acfd2-8e96-4b9e-a9ce-45128bd52e88</ikar:districtGuid> </ikar:locality> </ikar:localityList> </ws:findLocalityListByNameResponse> </SOAP-ENV:Body>
</soapenv:Envelope> </syntaxhighlight>