FindStreetListByName

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

Метод позволяет получить список улиц по идентификатору населённого пункта и названию или его части.

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

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

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

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

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

Объект findStreetListByNameRequest

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

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

Объект ..Request/listOptions

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

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

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

Объект findStreetListByNameResponse

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

Поле	Описание	Тип данных	Обязательность
streetList	Объект содержит улиц указанного населённого пункта	ikar:StreetList	1

Объект ..Response/streetList

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

Поле	Описание	Тип данных	Обязательность
street	Данные улицы	ikar:Street	1

Объект ..Response/streetList/street

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

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

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

Запрос списка улиц г.Москва, в названии которых есть слово "Большая"

<codeblock> <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:findStreetListByNameRequest>
        <base:listOptions>
           <base:count>100</base:count>
           <base:offset>0</base:offset>
        </base:listOptions>
        <ikar:localityGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</ikar:localityGuid>
        <ws:pattern>Большая</ws:pattern>
     </ws:findStreetListByNameRequest>
  </soapenv:Body>

</soapenv:Envelope> </syntaxhighlight>