FindLocalityListByName

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

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

Метод позволяет получить населённый пункт или населённые пункты, подчинённые региону, задав название или его часть. В список попадают только активные записи населённых пунктов, у которых глобальный идентификатор региона равен запрошенному. Метод поддерживает возможность частичного вывода списка.

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


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

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

Объект ..Response/localityList/locality

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

Поле Описание Текст заголовка Текст заголовка
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
countryGuid Глобальный идентификатор страны bs:UUID 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:findLocalityListByNameRequest>
        <base:listOptions>
           <base:count>100</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>