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

Версия 10:15, 1 ноября 2016

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

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

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

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

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

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

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

Объект getRegionListByCountryRequest

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

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

Объект ..Request/listOptions

Объект содержит параметры запрашиваемого списка.

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

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

Объект getRegionListByCountryResponse

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

Поле	Описание	Тип данных	Обязательность
regionList	Список регионов.	ikar:RegionList	1

Объект ..Response/regionList

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

Поле	Описание	Тип данных	Обязательность
region	Объект, описывающий регион.	ikar:Region	1

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

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

Объект ..Response/regionList/region

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

Поле	Описание	Тип данных	Обязательность
UUID	Идентификатор версии записи о регионе страны в реестре системы Икар.	bs:UUID	1
GUID	Глобальный идентификатор региона страны в реестре системы Икар.	bs:UUID	1
active	Флаг, указывающий активна ли запись.	xs:boolean	1
last	Флаг, указывающий, является ли версия записи последней.	xs:boolean	1
status	Статус записи.	bs:VersionStatus	1
createDate	Дата создания записи.	xs:date	1
updateDate	Дата обновления записи.	xs:date	1
previous	Идентификатор предыдущей версии записи.	bs:UUID	0..1
name	Название региона.	xs:string	1
englishName	Название региона на английском языке.	xs:string	0..1
view	Представление объекта (обычно это название + название типа объекта). Например: Владимирская обл.	bs:String255	1
regionCode	Код региона Например: 33 (код Владимирской области).	xs:string	0..1
type	Название типа адресного объекта (например, область, район или город). Например: обл.	bs:String255	1
countryGuid	Глобальный идентификатор страны, к которой относится данный объект.	bs:UUID	1
hasStreets	Флаг, указывающий наличие улиц.	xs:boolean	1

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

Запрос списка первых 3 регионов Австралии

<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:getRegionListByCountryRequest>
      <base:listOptions>
        <base:count>10</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <ikar:countryGuid>f133f1fd-7fa2-da91-d069-24df64749742</ikar:countryGuid>
    </ws:getRegionListByCountryRequest>
  </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:getRegionListByCountryResponse 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:regionList count="3" total="8" offset="0">
      <ikar:region>
        <bs:uuid>12a269b4-f039-983b-66ae-d3bdca7f53ab</bs:uuid>
        <bs:guid>46a0888e-73d2-b209-154f-f121629a97f1</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2012-08-09T13:34:57+04:00</bs:createDate>
        <bs:updateDate>2012-08-09T13:34:57+04:00</bs:updateDate>
        <ikar:name>Виктория</ikar:name>
        <ikar:englishName>Victoria</ikar:englishName>
        <ikar:view>Виктория</ikar:view>
        <ikar:type/>
        <ikar:countryGuid>f133f1fd-7fa2-da91-d069-24df64749742</ikar:countryGuid>
        <ikar:hasStreets>false</ikar:hasStreets>
      </ikar:region>
      <ikar:region>
        <bs:uuid>f58a2a93-46fc-6ff0-c73a-103cd756cc6b</bs:uuid>
        <bs:guid>830a1e3b-87a2-85e6-388f-a4bf16e9a771</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2012-08-09T13:34:57+04:00</bs:createDate>
        <bs:updateDate>2012-08-09T13:34:57+04:00</bs:updateDate>
        <ikar:name>Западная Австралия</ikar:name>
        <ikar:englishName>Western Australia</ikar:englishName>
        <ikar:view>Западная Австралия</ikar:view>
        <ikar:type/>
        <ikar:countryGuid>f133f1fd-7fa2-da91-d069-24df64749742</ikar:countryGuid>
        <ikar:hasStreets>false</ikar:hasStreets>
      </ikar:region>
      <ikar:region>
        <bs:uuid>8e528213-b703-8b18-a59f-ad1823ba42ab</bs:uuid>
        <bs:guid>58e64b1f-bba4-0f8a-ae61-5097359eccf8</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2012-08-09T13:34:57+04:00</bs:createDate>
        <bs:updateDate>2012-08-09T13:34:57+04:00</bs:updateDate>
        <ikar:name>Квинсленд</ikar:name>
        <ikar:englishName>Queensland</ikar:englishName>
        <ikar:view>Квинсленд</ikar:view>
        <ikar:type/>
        <ikar:countryGuid>f133f1fd-7fa2-da91-d069-24df64749742</ikar:countryGuid>
        <ikar:hasStreets>false</ikar:hasStreets>
      </ikar:region>
    </ikar:regionList>
  </ws:getRegionListByCountryResponse>
 </SOAP-ENV:Body>
</soapenv:Envelope>

@@ Строка 76: / Строка 76: @@
 |-
 | '''[[#Объект ..Response/regionList/region|region]]''' || Объект, описывающий регион. || [[Region|ikar:Region]] || 1
+|}
+'''Атрибуты списка regionList'''
+{| class="wikitable"
+|-
+! Атрибут !! Описание !! Тип данных !! Обязательность
+|-
+| '''count''' || Размер списка, передаваемого в ответе на запрос. || [http://www.w3.org/TR/xmlschema-2/#integer xs:int] || 1
+|-
+| '''total''' || Размер всего списка, удовлетворяющего запросу.|| [http://www.w3.org/TR/xmlschema-2/#long xs:long] || 1
+|-
+| '''offset''' || Смещение первого элемента передаваемого списка во всем списке результатов, удовлетворяющих запросу. || [http://www.w3.org/TR/xmlschema-2/#integer xs:int] || 1
 |}