GetLocalityListByDistrict: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 124: | Строка 124: | ||
Запрос списка населённых пунктов Киришского района | Запрос списка населённых пунктов Киришского района | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
< | <syntaxhighlight lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" | ||
xmlns:ws="http://api.vetrf.ru/schema/cdm/ikar/ws-definitions" | xmlns:ws="http://api.vetrf.ru/schema/cdm/ikar/ws-definitions" | ||
Версия 14:40, 19 октября 2016
Общие сведения
Метод позволяет получить список городов района. В список попадают только активные записи городов, у которых глобальный идентификатор района равен запрошенному. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект getLocalityListByDistrictRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка и идентификатор района.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| listOptions | Параметры возвращаемого списка: количество элементов и смещение | bs:ListOptions | 0..1 |
| districtGUID | Идентификатор района | bs:UUID | 1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
| offset | Смещение в списке относительно начала | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект getLocalityListByDistrictResponse
Корневой объект ответа.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| localityList | Объект содержит список районов | ikar:LocalityList | 1 |
Объект ..Response/localityList
Объект содержит список районов указанного региона.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| locality | Данные района | ikar:Locality | 1 |
Объект ..Response/localityList/locality
Объект, содержащий данные района.
| Поле | Описание | Текст заголовка | Текст заголовка |
|---|---|---|---|
| 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 |
Пример запроса
Запрос списка населённых пунктов Киришского района
<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:getLocalityListByDistrictRequest>
<base:listOptions>
<base:count>20</base:count>
<base:offset>0</base:offset>
</base:listOptions>
<ikar:districtGuid>4c3585cc-fdec-4826-8736-53aa064ec41b</ikar:districtGuid>
</ws:getLocalityListByDistrictRequest>
</soapenv:Body>
</soapenv:Envelope>
