GetRegionListByCountry
Версия от 12:36, 19 октября 2016; Egorova-iv-150707 (обсуждение | вклад) (→Объект getRegionListByCountryResponse)
Общие сведения
Метод позволяет получить список регионов страны. В список попадают только активные записи регионов, у которых глобальный идентификатор страны равен запрошенному. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект getRegionListByCountryRequest
Корневой объект запроса. Содержит параметры получаемого списка.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры запрашиваемого списка: смещение и количество выводимых записей. | bs:ListOptions | 0..1 |
countryGuid | Глобальный уникальный идентификатор страны, для которой запрашивается поиск регионов | bs:UUID | 1 |
Объект ..Request/listOptions
Объект содержит параметры запрашиваемого списка.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект getRegionListByCountryResponse
Корневой объект ответа. Содержит информацию о списке регионов указанной страны.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
regionList | Список регионов | ikar:RegionList | 1 |
Объект ..Response/regionList
Объект, содержащий список регионов.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
region | Объект, описывающий регион | ikar:Region | 1 |
Объект ..Response/regionList/region
Объект, описывающий регион.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
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 |
englishName | Название региона страны на английском языке | xs:string | 1 |
view | Представление объекта (обычно это название + название типа объекта) | bs:String255 | 1 |
type | Название типа адресного объекта (например, область, район или город) | bs:String255 | 1 |
countryGuid | Глобальный идентификатор страны, к которой относится данный объект. | bs:UUID | 1 |
hasStreets | Флаг, указывающий наличие улиц | xs:boolean | 1 |
Пример запроса
Запрос списка первых 10 регионов Австралии
<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"
xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
<soapenv:Header/>
<soapenv:Body>
<ws:getRegionListByCountryRequest>
<base:listOptions>
<base:count>10</base:count>
<base:offset>0</base:offset>
</base:listOptions>
<ikar:countryGuid>f133f1fd-7fa2-da91-d069-24df64749742</ikar:countryGuid>
</ws:getRegionListByCountryRequest>
</soapenv:Body>
</soapenv:Envelope>