Egorova-iv в 12:11, 17 октября 2016

2016-10-17T12:11:39Z

← Предыдущая версия		Версия от 12:11, 17 октября 2016
Строка 34:		Строка 34:
	\| [[#Объект ..Request/listOptions\|'''listOptions''']] \|\| Параметры возвращаемого списка: количество элементов и смещение \|\| [[ListOptions\|bs:ListOptions]] \|\| 0..1		\| [[#Объект ..Request/listOptions\|'''listOptions''']] \|\| Параметры возвращаемого списка: количество элементов и смещение \|\| [[ListOptions\|bs:ListOptions]] \|\| 0..1
	\|-		\|-
	\| '''regionGuid''' \|\| Идентификатор ~~населённого пункта~~ \|\| [[UUID\|bs:UUID]] \|\| 1		\| '''regionGuid''' \|\| Идентификатор региона \|\| [[UUID\|bs:UUID]] \|\| 1
	\|}		\|}

	===Объект [[#Объект ~~getLocalityListByRegion~~\|..Request]]/listOptions===		===Объект [[#Объект getLocalityListByRegionRequest\|..Request]]/listOptions===

	Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.		Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.

Egorova-iv: Новая страница: «==Общие сведения== Метод позволяет получить список городов, подчинённых региону. В список…»

2016-10-17T11:39:13Z

Новая страница: «==Общие сведения== Метод позволяет получить список городов, подчинённых региону. В список…»

Новая страница

==Общие сведения==
Метод позволяет получить список городов, подчинённых региону. В список попадают только активные записи городов, у которых глобальный идентификатор региона равен запрошенному. Метод поддерживает возможность частичного вывода списка.

===Используемые пространства имён и типы===

{{столбцы}}
{{столбец}}
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
** [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
** [[LocalityList|ikar:LocalityList]]
** [[Locality|ikar:Locality]]

{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|base]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[UUID|bs:UUID]]
** [[VersionStatus|bs:VersionStatus]]
{{столбцы/конец}}

==Данные запроса==

===Объект getLocalityListByRegionRequest===

Корневой объект запроса. Содержит параметры запрашиваемого списка и идентификатор региона.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры возвращаемого списка: количество элементов и смещение || [[ListOptions|bs:ListOptions]] || 0..1
|-
| '''regionGuid''' || Идентификатор населённого пункта || [[UUID|bs:UUID]] || 1
|}

===Объект [[#Объект getLocalityListByRegion|..Request]]/listOptions===

Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''count''' || Количество значений в списке
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
|}

==Данные ответа==

===Объект getLocalityListByRegionResponse ===

Корневой объект ответа.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/localityList|'''localityList''']] || Объект содержит список районов || [[LocalityList|ikar:LocalityList]] || 1
|}

===Объект [[#Объект getLocalityListByRegionResponse|..Response]]/localityList===

Объект содержит список населённых пунктов, подчинённых региону.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/localityList/locality|'''locality''']] || Данные населённого пункта || [[Locality|ikar:Locality]] || 1
|}

===Объект [[#Объект getLocalityListByRegionResponse|..Response]]/[[#Объект ..Response/localityList|localityList]]/locality===

Объект, содержащий данные населённого пункта.

{| 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''' || Номер региона согласно территориально-административному делению РФ (01-85) || [[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

|}

==Пример запроса==

<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос списка населённых пунктов г. Санкт-Петербург (как региона). Ответ будет содержать не только посёлки, но и подчинённые города.
<div class = "mw-collapsible-content">
<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:getLocalityListByRegionRequest>
<base:listOptions>
<base:count>100</base:count>
<base:offset>0</base:offset>
</base:listOptions>
<ikar:regionGuid>c2deb16a-0330-4f05-821f-1d09c93331e6</ikar:regionGuid>
</ws:getLocalityListByRegionRequest>
</soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>

GetLocalitListByRegion - История изменений

Egorova-iv в 12:11, 17 октября 2016

Egorova-iv: Новая страница: «==Общие сведения== Метод позволяет получить список городов, подчинённых региону. В список…»