GetRegionByUUID

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

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

Операция GetRegionByUUID предназначена для получения информации о регионе по идентификатору версии записи. В общем случае запись может быть не актуальной и/или не последней (т.е. может быть active = false, last = false). Выполнение операции заканчивается либо возвратом объекта региона, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

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

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

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

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса
IncorrectRequestFault Некорректный запрос. Возникает, если
  • запрос не соответствует требованиям указанным в xsd;
  • указанный UUID неверен;
  • UUID указан в неверном формате.
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">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getRegionByUuidRequest>
      <base:uuid>12a269b4-f039-983b-66ae-d3bdca7f53ab</base:uuid>
    </ws:getRegionByUuidRequest>
  </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:getRegionByUuidResponse 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: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>
    </ws:getRegionByUuidResponse>
  </SOAP-ENV:Body>
</soapenv:Envelope>