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

Текущая версия на 10:40, 15 декабря 2016

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

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

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

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)

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

параметры выводимого списка.

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

список записей населённых пунктов, относящихся к указанному району, актуальных и последних (active=true, last=true).

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

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

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

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

Описание ошибок

Ошибка	Описание
InternalServiceFault	Внутренняя ошибка сервиса.
IncorrectRequestFault	Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.
EntityNotFoundFault	Указанный в запросе район не найден.

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

Запрос списка первых двух населённых пунктов Киришского района со смещением, равным единице.

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

Ответ на запрос.

<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:getLocalityListByDistrictResponse 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:localityList count="2" total="116" offset="1">
        <ikar:locality>
          <bs:uuid>2c103268-56c6-4ca3-847c-ce9cb2fb5a5c</bs:uuid>
          <bs:guid>faee2b8f-2e3c-42b4-8c47-3e8b3e70e2f9</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2012-04-10T00:00:00+04:00</bs:createDate>
          <bs:updateDate>2012-05-03T00:00:00+04:00</bs:updateDate>
          <bs:previous>214bd53a-73cf-42d1-8309-5641547ae708</bs:previous>
          <ikar:name>Андреево</ikar:name>
          <ikar:view>п/ст Андреево</ikar:view>
          <ikar:regionCode>47</ikar:regionCode>
          <ikar:type>п/ст</ikar:type>
          <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
          <ikar:hasStreets>true</ikar:hasStreets>
        </ikar:locality>
        <ikar:locality>
          <bs:uuid>c1a9ee62-0bf5-4887-a40c-8e5236b3d9d0</bs:uuid>
          <bs:guid>fd69de8a-8bc8-4ce5-823c-b5f622b4bd9c</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2012-04-10T00:00:00+04:00</bs:createDate>
          <bs:updateDate>2012-05-03T00:00:00+04:00</bs:updateDate>
          <bs:previous>55c98c12-13de-4ba3-a32f-25d4c07c0357</bs:previous>
          <ikar:name>Андреево</ikar:name>
          <ikar:view>п/ст Андреево</ikar:view>
          <ikar:regionCode>47</ikar:regionCode>
          <ikar:type>п/ст</ikar:type>
          <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
          <ikar:hasStreets>true</ikar:hasStreets>
        </ikar:locality>
      </ikar:localityList>
    </ws:getLocalityListByDistrictResponse>
  </SOAP-ENV:Body>
</soapenv:Envelope>

@@ Строка 41: / Строка 41: @@
 | [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры возвращаемого списка: количество элементов и смещение. || [[ListOptions|bs:ListOptions]] || 0..1
 |-
-| '''districtGUID''' || Идентификатор района. || [[UUID|bs:UUID]] || 1
+| '''districtGUID''' || Глобальный идентификатор района. || [[UUID|bs:UUID]] || 1
 |}
@@ Строка 111: / Строка 111: @@
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Запрос списка первых двух населённых пунктов Киришского района.
+Запрос списка первых двух населённых пунктов Киришского района со смещением, равным единице.
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
@@ Строка 122: / Строка 122: @@
      <ws:getLocalityListByDistrictRequest>
        <base:listOptions>
-         <base:count>20</base:count>
+         <base:count>2</base:count>
-         <base:offset>0</base:offset>
+         <base:offset>1</base:offset>
        </base:listOptions>
        <ikar:districtGuid>4c3585cc-fdec-4826-8736-53aa064ec41b</ikar:districtGuid>
@@ Строка 183: / Строка 183: @@
 </div>
 </div>
+[[Category:Ветис.API]]
+[[Category:IkarService]]
+[[Category:Реестры]]