GetDistrictByGuid: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Метод разработан для получения данных о районе по его уникальному идентификатору в системе Икар. | |||
===Используемые пространства имён и типы=== | ===Используемые пространства имён и типы=== | ||
Версия 16:44, 31 октября 2016
Общие сведения
Метод разработан для получения данных о районе по его уникальному идентификатору в системе Икар.
Используемые пространства имён и типы
|
|
Данные запроса
Объект getDistrictByGuidRequest
Корневой объект запроса. Содержит идентификатор запрашиваемого района.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| GUID | Глобальный идентификатор района в реестре Россельхознадзора. | bs:UUID | 1 |
Данные ответа
Объект getDistrictByGuidResponse
Корневой объект ответа. Содержит данные района, который найден по указанному идентификатору.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| district | Данные района. | ikar:District | 1 |
Объект ..Response/district
Объект, содержащий данные района.
| Поле | Описание | Текст заголовка | Текст заголовка |
|---|---|---|---|
| UUID | Уникальный идентификатор версии записи | bs:UUID | 1 |
| GUID | Глобальный уникальный идентификатор записи | bs:UUID | 1 |
| active | Флаг, указывающий активна ли запись | xs:boolean | 1 |
| previous | Флаг, указывающий наличие предыдущей записи | xs:boolean | 1 |
| last | Флаг, указывающий, является ли версия записи последней | xs:boolean | 1 |
| status | Статус записи | bs:VersionStatus | 1 |
| createDate | Дата создания записи | xs:date | 1 |
| updateDate | Дата обновления записи | xs:date | 1 |
| name | Название региона страны | xs:string | 1 |
| view | Представление объекта. Обычно это название + тип | bs:String255 | 1 |
| regionCode | Глобальный идентификатор региона | bs:UUID | 1 |
| type | Название адресного типа | bs:String255 | 1 |
| countryGuid | Глобальный идентификатор страны | bs:UUID | 1 |
| hasStreets | Флаг, указывающий на наличие улиц | xs:boolean | 1 |
| regionGuid | Глобальный идентификатор региона, которому принадлежит район | bs:UUID | 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:getDistrictByGuidRequest>
<base:guid>762758bb-18b9-440f-bc61-8e1e77ff3fd8</base:guid>
</ws:getDistrictByGuidRequest>
</soapenv:Body>
</soapenv:Envelope>
