GetStreetListByLocality: различия между версиями

Версия 16:30, 31 октября 2016

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

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

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

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

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

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

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

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

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

Запрос списка улиц села Камышлы

<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>100</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>

@@ Строка 35: / Строка 35: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры возвращаемого списка: количество элементов и смещение || [[ListOptions|bs:ListOptions]] || 0..1
+| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры возвращаемого списка: количество элементов и смещение. || [[ListOptions|bs:ListOptions]] || 0..1
 |-
-| '''localityGuid''' || Идентификатор региона || [[UUID|bs:UUID]] || 1
+| '''localityGuid''' || Идентификатор региона. || [[UUID|bs:UUID]] || 1
 |}
@@ Строка 50: / Строка 50: @@
 | '''count''' || Количество значений в списке
 * По умолчанию значение равно 100;
-* Максимально допустимое значение равно 1000
+* Максимально допустимое значение равно 1000.
 || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |-
-| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
+| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |-
 |}