GetLocalityListByLocality
Общие сведения
Операция GetLocalityListByLocality предназначена для получения списка населённых пунктов, подчинённых указанному населённому пункту. В список попадают только активные записи населённых пунктов (active=true, last=true), у которых глобальный идентификатор равен запрошенному. Выполнение операции заканчивается либо возвратом списка населенных пунктов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса. Операция поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Входные данные
- параметры выводимого списка.
Выходные данные
- список записей населённых пунктов, относящихся к указанному населённому пункту, актуальных и последних (active=true, last=true).
Данные запроса
Объект getLocalityListByLocalityRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка и идентификатор населённого пункта.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры возвращаемого списка: количество элементов и смещение. | bs:ListOptions | 0..1 |
localityGUID | Глобальный идентификатор населённого пункта. | bs:UUID | 1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект getLocalityListByLocalityResponse
Корневой объект ответа.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
localityList | Объект содержит список населённых пунктов. | ikar:LocalityList | 1 |
Атрибуты списка localityList
Атрибут | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество элементов списка, запрашиваемое или переданное. | xs:int | 1 |
total | Общий размер списка. | xs:long | 1 |
offset | Смещение первого элемента списка относительно его начала. | xs:int | 1 |
Объект ..Response/localityList
Объект содержит список населённых пунктов, подчинённых данному населённому пункту.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
locality | Данные населённого пункта. | ikar:Locality | 0..* |
Объект ..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 | Ошибка, свидетельствующая о том, что населённый пункт с указанным глобальным идентификатором не найден. |
Пример запроса
Запрос списка первых трёх населённых пунктов г. Санкт-Петербург. Будут возвращены только посёлки.
<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:getLocalityListByLocalityRequest>
<base:listOptions>
<base:count>3</base:count>
<base:offset>0</base:offset>
</base:listOptions>
<ikar:localityGuid>c2deb16a-0330-4f05-821f-1d09c93331e6</ikar:localityGuid>
</ws:getLocalityListByLocalityRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<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:getLocalityListByLocalityResponse 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="21" 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>14f07ea8-5961-4364-81c3-331f2aa2db51</bs:uuid>
<bs:guid>71a7dcf9-91c5-48d6-a862-ea3bf4cd1534</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-03-18T00: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:getLocalityListByLocalityResponse>
</SOAP-ENV:Body>
</soapenv:Envelope>