GetStreetListByLocality

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

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

Операция GetStreetListByLocality предназначена для получения списка записей улиц с активным статусом (active=true, last=true) по населённому пункту. Выполнение операции заканчивается либо возвратом списка улиц, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса. Операция поддерживает частичный вывод списка.

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

Входные данные

  • параметры выводимого списка.
  • идентификатор населённого пункта.

Выходные данные

  • список записей улиц, актуальных и последних (active=true, last=true).

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

Объект getStreetListByLocalityRequest

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

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

Объект ..Request/listOptions

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

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

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

Объект getStreetListByLocalityResponse

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

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

Объект ..Response/streetList

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

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

Атрибуты списка streetList

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

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

Объект содержит информацию об улице.

Поле Описание Тип данных Обязательность
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 Дата обновления записи. Если запись не обновлялась, то указывается значение createDate. xs:date 1
name Название улицы. xs:string 1
view Представление объекта. Обычно это название + его тип
  • Например: ул.Ленина.
 bs:String255 1
regionCode Код региона
  • Например: 33 (код Владимирской области).
 xs:string 1
type Сокращённое название адресного типа
  • Например, ул.
 bs:String255 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:getStreetListByLocalityRequest>
        <base:listOptions>
           <base:count>2</base:count>
           <base:offset>0</base:offset>
        </base:listOptions>
        <ikar:localityGuid>f7f48953-6fc5-4ed6-8ca9-4d7f6c370a2f</ikar:localityGuid>
     </ws:getStreetListByLocalityRequest>
  </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:getStreetListByLocalityResponse 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:streetList count="2" total="2" offset="0">
       <ikar:street>
         <bs:uuid>0c43a94e-7f36-4a60-bf8d-1c6288347a5c</bs:uuid>
         <bs:guid>6e5f3af7-611c-41d6-aaea-5b606f2b7e25</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>bf3b1486-029f-4b34-9daa-9495db172275</bs:previous>
         <ikar:name>Камышловская</ikar:name>
         <ikar:view>Камышловская ул.</ikar:view>
         <ikar:regionCode>92</ikar:regionCode>
         <ikar:type>ул.</ikar:type>
         <ikar:hasStreets>false</ikar:hasStreets>
       </ikar:street>
       <ikar:street>
         <bs:uuid>c0765b7a-bf24-4ce0-a226-a87a505289b0</bs:uuid>
         <bs:guid>62644191-b9b6-4e9b-8c8a-d8c9cde87657</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>f587769d-5f6f-4beb-aa48-db91f36fc7ac</bs:previous>
         <ikar:name>Орта-Мале</ikar:name>
         <ikar:view>Орта-Мале ул.</ikar:view>
         <ikar:regionCode>92</ikar:regionCode>
         <ikar:type>ул.</ikar:type>
         <ikar:hasStreets>false</ikar:hasStreets>
       </ikar:street>
     </ikar:streetList>
   </ws:getStreetListByLocalityResponse>
 </SOAP-ENV:Body>

</soapenv:Envelope> </syntaxhighlight>

Источник — http://help.vetrf.ru/index.php?title=GetStreetListByLocality&oldid=19214