Herriot:GetRegionListByCountry:v1.0

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

Код	Описание операции
IS.HRT.2.3	Получение списка всех регионов заданной страны

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getRegionListByCountryRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка
003	······<bs:count>?</bs:count>	xs:nonNegativeInteger	[0..1]	Максимальное запрашиваемое количество объектов в списке По умолчанию значение 100; Максимально возможное значение 1000
004	······<bs:offset>?</bs:offset>	xs:nonNegativeInteger	[0..1]	Номер элемента, по которому осуществляется смещение первого элемента списка По умолчанию значение 0.
005	···</bs:listOptions>
006	···<dt:countryGuid>?</dt:countryGuid>	bs:UUID	[1..1]	Глобальный идентификатор записи
007	</ws:getRegionListByCountryRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getRegionListByCountryResponse>
002	···<dt:regionList total="?" offset="?" count="?">	dt:EntityList	[1..1]	Список регионов total - всего записей offset - смещение относительно первого элемента count - количество выводимых записей
003	······<dt:region>	dt:Region	[0..*]	Данные о регионе
004	·········<bs:uuid>?</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии записи
005	·········<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор записи
006	·········<bs:active>?</bs:active>	xs:boolean	[1..1]	Флаг активности записи true - запись активна; false - запись не активна.
007	·········<bs:last>?</bs:last>	xs:boolean	[1..1]	Флаг, указывающий на то, что запись является последней в истории true - да; false - нет.
008	·········<bs:status>?</bs:status>	bs:VersionStatus	[1..1]	Статус записи
009	·········<bs:createDate>?</bs:createDate>	xs:DateTime	[1..1]	Дата создания записи
010	·········<bs:updateDate>?</bs:updateDate>	xs:DateTime	[1..1]	Дата последнего изменения записи
011	·········<bs:previous>?</bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи
012	·········<bs:next>?</bs:next>	bs:UUID	[0..1]	Идентификатор следующей версии записи
013	·········<dt:name>?</dt:name>	bs:String255	[0..1]	Наименование страны
014	·········<dt:englishName>?</dt:englishName>	bs:String255	[0..1]	Полное наименование страны
015	·········<dt:view>?</dt:view>	bs:Strign255	[1..1]	Строковое название населенного пункта
016	·········<dt:regionCode>?</dt:regionCode>	xs:string	[1..1]	Код региона
017	·········<dt:type>?</dt:type>	bs:String255	[1..1]	Название типа адресного объекта
018	·········<dt:countryGuid>?</dt:countryGuid>	bs:UUID	[1..1]	Глобальный идентификатор страны, к которой относится регион
019	·········<dt:hasStreets>?</dt:hasStreets>	xs:boolean	[1..1]	Флаг указывающий на наличие улиц true - запись активна; false - запись не активна.
020	······</dt:region>
021	···</dt:regionList>
022	</ws:getRegionListByCountryResponse>

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

TODO

См. также

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