GetDistrictListByRegion: различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «==Общие сведения== Метод позволяет получить список районов региона. В список попадают тол…») |
|||
| Строка 59: | Строка 59: | ||
=== Объект getDistrictListByRegionResponse === | === Объект getDistrictListByRegionResponse === | ||
Корневой объект ответа. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| [[#Объект ..Response/districtList|'''districtList''']] || Объект содержит список районов || [[DistrictList|ikar:DistrictList]] || 1 | |||
|} | |||
===Объект ..Response/districtList=== | |||
Объект содержит список районов указанного региона. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| [[#Объект ..Response/districtList/district|'''district''']] || Данные района || [[District|ikar:District]] || 1 | |||
|} | |||
===Объект ..Response/districtList/district=== | |||
Объект, содержащий данные района. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Текст заголовка !! Текст заголовка | |||
|- | |||
| '''UUID''' || Уникальный идентификатор версии записи || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный уникальный идентификатор записи || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''active''' || Флаг, указывающий активна ли запись || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''previous''' || Флаг, указывающий наличие предыдущей записи || [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 | |||
|- | |||
| '''view''' || Представление объекта. Обычно это название + тип || [[String255|bs:String255]] || 1 | |||
|- | |||
| '''regionCode''' || Глобальный идентификатор региона || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''type''' || Название адресного типа || [[String255|bs:String255]] || 1 | |||
|- | |||
| '''countryGuid''' || Глобальный идентификатор страны || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''hasStreets''' || Флаг, указывающий на наличие улиц || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''regionGuid''' || Глобальный идентификатор региона, которому принадлежит район || [[UUID|bs:UUID]] || 1 | |||
|} | |||
Версия 09:58, 6 сентября 2016
Общие сведения
Метод позволяет получить список районов региона. В список попадают только активные записи районов, у которых глобальный идентификатор региона равен запрошенному. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект getDistrictListByRegionRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка и идентификатор региона.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| listOptions | Параметры возвращаемого списка: количество элементов и смещение | bs:ListOptions | 0..1 |
| regionGUID | Идентификатор региона | bs:DateInterval | 0..1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
| offset | Смещение в списке относительно начала | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект getDistrictListByRegionResponse
Корневой объект ответа.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| districtList | Объект содержит список районов | ikar:DistrictList | 1 |
Объект ..Response/districtList
Объект содержит список районов указанного региона.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| district | Данные района | ikar:District | 1 |
Объект ..Response/districtList/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 |
