GetAllCountryList: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Метод разработан для получения списка всех стран мира. | Метод GetAllCountryList разработан для получения списка всех стран мира. | ||
===Используемые пространства имён и типы=== | ===Используемые пространства имён и типы=== | ||
Версия 16:32, 31 октября 2016
Общие сведения
Метод GetAllCountryList разработан для получения списка всех стран мира.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект getAllCountryListRequest
Корневой объект запроса. Содержит параметры запрашиваемого списка.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| listOptions | Параметры запрашиваемого списка. | bs:ListOptions | 0..1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
| offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект getAllCountryListResponse
Корневой объект ответа. Содержит список возвращаемых стран.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| countryList | Объект, содержащий запрашиваемый список стран. | ikar:CountryList | 1 |
Объект ..Response/countryList
Объект содержит список стран
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| country | Объект содержит информацию о стране. | ikar:Country | 1..* |
Объект ..Response/countryList/country
Объект содержит информацию о стране.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| 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 |
| previous | Идентификатор предыдущей версии записи. | bs:UUID | 0..1 |
| name | Название страны (например, Белоруссия). | xs:string | 1 |
| fullName | Полное название страны (например, Республика Беларусь). | xs:string | 1 |
| englishName | Название страны на английском языке. | xs:string | 1 |
| code | Двухбуквенный код страны в соответствии со стандартом ISO 3166-1 alpha-2. | xs:string | 1 |
| code3 | Трёхбуквенный код страны в соответствии со стандартом ISO 3166-1 alpha-3. | xs:string | 1 |
Пример запроса
Запрос списка из 10 стран с нулевым смещением от начала списка.
<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">
<soapenv:Header/>
<soapenv:Body>
<ws:getAllCountryListRequest>
<base:listOptions>
<base:count>10</base:count>
<base:offset>0</base:offset>
</base:listOptions>
</ws:getAllCountryListRequest>
</soapenv:Body>
</soapenv:Envelope>
