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

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

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

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

Пространства имён и типы

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

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

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

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

Объект getRegionByGuidRequest

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

Поле	Описание	Тип данных	Обязательность
GUID	Уникальный идентификатор версии записи о регионе.	bs:UUID	1

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

Объект getRegionByGuidResponse

Корневой объект ответа. Содержит версию объекта с идентификатором, по котором осуществлялся поиск.

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

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

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

Запрос данных об одном из регионов Австралии

<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:getRegionByUuidRequest>
         <base:guid>46a0888e-73d2-b209-154f-f121629a97f1</base:guid>
      </ws:getRegionByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope>

@@ Строка 43: / Строка 43: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/region|'''region''']] || Объект, описывающий регион || [[Region|ikar:Region]] || 1
+| [[#Объект ..Response/region|'''region''']] || Объект, описывающий регион. || [[Region|ikar:Region]] || 1
 |}