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

Версия 12:44, 19 октября 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)

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

Объект getRegionByUuidRequest

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

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

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

Объект getRegionByUuidResponse

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

Поле	Описание	Тип данных	Обязательность
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
name	Название региона страны	xs:string	1
englishName	Название региона страны на английском языке	xs:string	1
view	Представление объекта (обычно это название + название типа объекта)	bs:String255	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:uuid>12a269b4-f039-983b-66ae-d3bdca7f53ab</base:uuid>
      </ws:getRegionByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope>

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