Herriot:GetRegionByGuid:v1.0

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

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

Код операции Описание операции
IS.HRT.2.2 Получение региона по глобальному идентификатору

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRegionByGuidRequest>
002 ···<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
003 </dt:getRegionByGuidRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRegionByGuidResponse>
002 ···<dt:region> dt:Region [1..1] Данные о регионе
003 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
004 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
005 ······<bs:active>?</bs:active> xs:boolean [1..1]

Флаг активности записи

  • true - запись активна;
  • false - запись не активна.
006 ······<bs:last>?</bs:last> xs:boolean [1..1]

Флаг, указывающий на то, что запись является последней в истории

  • true - да;
  • false - нет.
007 ······<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус записи
008 ······<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания записи
009 ······<bs:updateDate>?</bs:updateDate> xs:DateTime [1..1] Дата последнего изменения записи
010 ······<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
011 ······<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
012 ······<dt:name>?</dt:name> bs:String255 [0..1] Наименование региона
013 ······<dt:englishName>?</dt:englishName> bs:String255 [0..1] Наименование региона (англ.)
014 ······<dt:view>?</dt:view> bs:Strign255 [1..1] Строковое название населенного пункта
015 ······<dt:regionCode>?</dt:regionCode> xs:string [1..1] Код региона
016 ······<dt:type>?</dt:type> bs:String255 [1..1] Название типа адресного объекта
017 ······<dt:countryGuid>?</dt:countryGuid> bs:UUID [1..1] Глобальный идентификатор страны, к которой относится регион
018 ······<dt:hasStreets>?</dt:hasStreets> xs:boolean [1..1]

Флаг указывающий на наличие улиц

  • true - запись активна;
  • false - запись не активна.
019 ···</dt:region>
020 </ws:getRegionByGuidResponse>

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API Herriot:Services:v1.0