GetRegionListByCountry: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 64: | Строка 64: | ||
! Поле !! Описание !! Тип данных !! Обязательность | ! Поле !! Описание !! Тип данных !! Обязательность | ||
|- | |- | ||
| '''regionList''' || Список регионов || [[RegionList|ikar:RegionList]] || 1 | | '''[[#Объект ..Request/regionList|regionList]]''' || Список регионов || [[RegionList|ikar:RegionList]] || 1 | ||
|} | |||
===Объект ..Request/'''regionList'''=== | |||
Объект, содержащий список регионов. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| '''[[#Объект ..Request/regionList/region|region]]''' || Объект, описывающий регион || [[Region|ikar:Region]] || 1 | |||
|} | |||
===Объект ..Request/regionList/'''region'''=== | |||
Объект, описывающий регион. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| '''UUID''' || Идентификатор версии записи о регионе страны в реестре РСХН || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный идентификатор региона страны в реестре РСХН || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''active''' || Флаг, указывающий активна ли запись || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''last''' || Флаг, указывающий, является ли версия записи последней || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''status''' || Статус записи || [[VersionStatus|bs:VersionStatus]] || 1 | |||
|- | |||
| '''createDate''' || Дата создания записи || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1 | |||
|- | |||
| '''updateDate''' || Дата обновления записи || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1 | |||
|- | |||
| '''name''' || Название региона страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|- | |||
| '''englishName''' || Название региона страны на английском языке ||[https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|- | |||
| '''view''' || Представление объекта (обычно это название + название типа объекта) || [[String255|bs:String255]] || 1 | |||
|- | |||
| '''type''' || Название типа адресного объекта (например, область, район или город) || [[String255|bs:String255]] || 1 | |||
|- | |||
| '''countryGuid'''|| Глобальный идентификатор страны, к которой относится данный объект. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''hasStreets''' || Флаг, указывающий наличие улиц || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|} | |} | ||
Версия 15:38, 1 сентября 2016
Общие сведения
Метод позволяет получить список регионов страны. В список попадают только активные записи регионов, у которых глобальный идентификатор страны равен запрошенному. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект 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 |
Объект ..Request/regionList
Объект, содержащий список регионов.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| region | Объект, описывающий регион | ikar:Region | 1 |
Объект ..Request/regionList/region
Объект, описывающий регион.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| 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 |
| name | Название региона страны | xs:string | 1 |
| englishName | Название региона страны на английском языке | xs:string | 1 |
| view | Представление объекта (обычно это название + название типа объекта) | bs:String255 | 1 |
| type | Название типа адресного объекта (например, область, район или город) | bs:String255 | 1 |
| countryGuid | Глобальный идентификатор страны, к которой относится данный объект. | bs:UUID | 1 |
| hasStreets | Флаг, указывающий наличие улиц | xs:boolean | 1 |
