GetDistrictByGuid
Перейти к навигации
Перейти к поиску
Общие сведения
Операция GetDistrictByGuid предназначена для получения актуальных данных о районе (active = true, last = true) по его глобальному идентификатору в системе Икар. Выполнение операции заканчивается либо возвратом объекта района, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
|
Входные данные
- глобальный идентификатор версии записи района.
Выходные данные
- запись о районе, у которой GUID совпадает с указанным в запросе идентификатором. Запись актуальная, то есть последняя и активная (active = true, last = true).
Данные запроса
Объект getDistrictByGuidRequest
Корневой объект запроса. Содержит идентификатор запрашиваемого района.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
GUID | Глобальный идентификатор района в реестре Россельхозндзора (система Икар). | bs:UUID | 1 |
Данные ответа
Объект getDistrictByGuidResponse
Корневой объект ответа. Содержит данные района, который найден по указанному идентификатору.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
district | Данные района. | ikar:District | 1 |
Объект ..Response/district
Объект содержит информацию о районе.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
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 |
view | Представление объекта. Обычно это название + тип.
|
bs:String255 | 1 |
regionCode | Код региона
|
xs:string | 1 |
type | Название адресного типа.
|
bs:String255 | 1 |
countryGuid | Глобальный идентификатор страны. | bs:UUID | 1 |
hasStreets | Флаг, указывающий на наличие улиц. | xs:boolean | 1 |
regionGuid | Глобальный идентификатор региона, которому принадлежит район. | bs:UUID | 1 |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Возникает, если:
|
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:getDistrictByGuidRequest>
<base:guid>762758bb-18b9-440f-bc61-8e1e77ff3fd8</base:guid>
</ws:getDistrictByGuidRequest>
</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:getDistrictByGuidResponse 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:district>
<bs:uuid>eedf7c75-04c5-4530-806f-28be84290f68</bs:uuid>
<bs:guid>762758bb-18b9-440f-bc61-8e1e77ff3fd8</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2012-09-17T00:00:00+04:00</bs:createDate>
<bs:updateDate>2013-02-04T00:00:00+04:00</bs:updateDate>
<bs:previous>762758bb-18b9-440f-bc61-8e1e77ff3fd8</bs:previous>
<ikar:name>Московский</ikar:name>
<ikar:view>п Московский</ikar:view>
<ikar:regionCode>77</ikar:regionCode>
<ikar:type>п</ikar:type>
<ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
<ikar:hasStreets>false</ikar:hasStreets>
<ikar:regionGuid>0c5b2444-70a0-4932-980c-b4dc0d3f02b5</ikar:regionGuid>
</ikar:district>
</ws:getDistrictByGuidResponse>
</SOAP-ENV:Body>
</soapenv:Envelope>