GetRegionListByCountry: различия между версиями

Версия 08:43, 30 августа 2016

Общие сведения

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

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

xs (http://www.w3.org/2001/XMLSchema)

ikar (http://api.vetrf.ru/schema/cdm/ikar)
- ikar:CountryList
- ikar:Country

base (http://api.vetrf.ru/schema/cdm/base)

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

Объект getRegionListByCountryRequest

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

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры запрашиваемого списка: смещение и количество выводимых записей.	bs:ListOptions	0..1
countryGuid	Глобальный уникальный идентификатор страны, для которой запрашивается поиск регионов	bs:UUID	1

Объект ..Request/listOptions

Объект содержит параметры запрашиваемого списка.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке По умолчанию значение равно 100; Максимально допустимое значение равно 1000	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала	xs:nonNegativeInteger	0..1

@@ Строка 37: / Строка 37: @@
 |}
-===Объект ..Request/listOptions===
+===Объект [[#Объект getRegionByCountryRequest|..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
+|-
+|}