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

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

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

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

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

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

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

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

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

Объект getLocalityListByDistrictRequest

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

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

Объект ..Request/listOptions

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

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

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

Объект getLocalityListByDistrictResponse

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

Поле	Описание	Тип данных	Обязательность
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	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	Код региона Например: 33 (код Владимирской области).	xs:string	1
type	Сокращённое название адресного типа: Например: г.	bs:String255	1
countryGuid	Глобальный идентификатор страны.	bs:UUID	1
hasStreets	Флаг, указывающий на наличие улиц.	xs:boolean	1

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

Запрос списка населённых пунктов Киришского района

<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:getLocalityListByDistrictRequest>
         <base:listOptions>
            <base:count>20</base:count>
            <base:offset>0</base:offset>
         </base:listOptions>
         <ikar:districtGuid>4c3585cc-fdec-4826-8736-53aa064ec41b</ikar:districtGuid>
      </ws:getLocalityListByDistrictRequest>
   </soapenv:Body>
</soapenv:Envelope>

@@ Строка 65: / Строка 65: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/localityList|'''localityList''']] || Объект содержит список районов || [[LocalityList|ikar:LocalityList]] || 1
+| [[#Объект ..Response/localityList|'''localityList''']] || Объект содержит список районов. || [[LocalityList|ikar:LocalityList]] || 1
 |}
@@ Строка 76: / Строка 76: @@
 ! Поле  !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/localityList/locality|'''locality''']] || Данные района || [[Locality|ikar:Locality]] || 1
+| [[#Объект ..Response/localityList/locality|'''locality''']] || Данные района. || [[Locality|ikar:Locality]] || 1
 |}
@@ Строка 82: / Строка 82: @@
 {{Ветис.API_Ikar_Locality}}
-<!--
-Объект, содержащий данные района.
-{| class="wikitable"
-|-
-! Поле !! Описание !! Текст заголовка !! Текст заголовка
-|-
-| '''UUID''' || Уникальный идентификатор версии записи || [[UUID|bs:UUID]] || 1
-|-
-| '''GUID''' || Глобальный уникальный идентификатор записи || [[UUID|bs:UUID]] || 1
-|-
-| '''active''' || Флаг, указывающий активна ли запись || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
-|-
-| '''previous''' || Флаг, указывающий наличие предыдущей записи || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
-|-
-| '''last''' || Флаг, указывающий, является ли версия записи последней || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
-|-
-| '''status''' || Статус записи || [[VersionStatus|bs:VersionStatus]] || 1
-|-
-| '''createDate''' || Дата создания записи || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
-|-
-| '''updateDate''' || Дата обновления записи || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
-|-
-| '''name''' || Название региона страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''view''' || Представление объекта. Обычно это название + тип || [[String255|bs:String255]] || 1
-|-
-| '''regionCode''' || Глобальный идентификатор региона || [[UUID|bs:UUID]] || 1
-|-
-| '''type''' || Название адресного типа || [[String255|bs:String255]] || 1
-|-
-| '''countryGuid''' || Глобальный идентификатор страны || [[UUID|bs:UUID]] || 1
-|-
-| '''hasStreets''' || Флаг, указывающий на наличие улиц || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
-|-
-| '''regionGuid''' || Глобальный идентификатор региона, которому принадлежит район || [[UUID|bs:UUID]] || 1
-|}
--->
 ==Пример запроса==