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

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

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

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

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

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

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

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

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

параметры выводимого списка.
интервал дат, за который требуется получить изменения.

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

список записей стран, изменённых за указанный период. Выводятся все записи, в том числе неактуальные, т.е. не активные и/или не последние.

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

Объект getRegionChangesListRequest

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

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры запрашиваемого списка.	bs:ListOptions	0..1
updateDateInterval	Интервал дат.	bs:DateInterval	1

Объект ..Request/listOptions

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

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

Объект ..Request/updateDateInterval

Объект содержит сведения об интервале времени, за который необходимо получить обновления.

Поле	Описание	Тип	Обязательность
beginDate	Дата, начиная с которой пользователь получит историю изменений записей стран.	xs:dateTime	1
endDate	Конец временного интервала. В случае, если компонента endDate не указана, то используется текущая дата.	xs:dateTime	0..1

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

Объект getRegionChangesListResponse

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

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

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

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

Объект ..Response/regionList

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

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

Объект ..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
next	Идентификатор следующей версии записи.	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

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

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

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

Запрос трёх изменённых регионов за период с 01.01.2013 по текущую дату со смещением, равным четырём.

<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">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getRegionChangesListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>4</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2013-01-01</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
    </ws:getRegionChangesListRequest>
  </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:getRegionChangesListResponse 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="2522" offset="4">
        <ikar:region>
          <bs:uuid>0af05e8b-21ff-4217-9a07-14d47ee04830</bs:uuid>
          <bs:guid>248d8071-06e1-425e-a1cf-d1ff4c4a14a8</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
          <bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
          <ikar:name>Карелия</ikar:name>
          <ikar:view>Республика Карелия</ikar:view>
          <ikar:regionCode>10</ikar:regionCode>
          <ikar:type>Республика</ikar:type>
          <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
          <ikar:hasStreets>false</ikar:hasStreets>
        </ikar:region>
        <ikar:region>
          <bs:uuid>13bd73c9-cfb8-418e-ae40-30273ef50d93</bs:uuid>
          <bs:guid>f136159b-404a-4f1f-8d8d-d169e1374d5c</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
          <bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
          <ikar:name>Чукотский</ikar:name>
          <ikar:view>Чукотский АО</ikar:view>
          <ikar:regionCode>87</ikar:regionCode>
          <ikar:type>АО</ikar:type>
          <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
          <ikar:hasStreets>false</ikar:hasStreets>
        </ikar:region>
        <ikar:region>
          <bs:uuid>18489346-08c0-41f4-9a46-b9d1f5a819d9</bs:uuid>
          <bs:guid>b8837188-39ee-4ff9-bc91-fcc9ed451bb3</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
          <bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
          <ikar:name>Владимирская</ikar:name>
          <ikar:view>Владимирская обл.</ikar:view>
          <ikar:regionCode>33</ikar:regionCode>
          <ikar:type>обл.</ikar:type>
          <ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
          <ikar:hasStreets>false</ikar:hasStreets>
        </ikar:region>
      </ikar:regionList>
    </ws:getRegionChangesListResponse>
  </SOAP-ENV:Body>
</soapenv:Envelope>

@@ Строка 26: / Строка 26: @@
 * интервал дат, за который требуется получить изменения.
-===Выходные данные===
+===[[#Объект getRegionChangesListResponse|Выходные данные]]===
 * список записей стран, изменённых за указанный период. Выводятся все записи, в том числе неактуальные, т.е. не активные и/или не последние.
@@ Строка 104: / Строка 104: @@
 ===Объект [[#Объект getRegionChangesListResponse|..Response]]/[[#Объект ..Response/regionList|regionList]]/'''region'''===
-{{Ветис.API Ikar Region }}
+{{Ветис.API Ikar Region|1}}
 ==Описание ошибок==
@@ Строка 209: / Строка 209: @@
 </div>
 </div>
+[[Category:Ветис.API]]
+[[Category:IkarService]]
+[[Category:Реестры]]