GetAllCountryList

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

Операция GetAllCountryList предназначена для получения списка актуальных записей всех стран мира (active=true, last=true). Выполнение операции заканчивается либо возвратом списка стран, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

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

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)

Входные данные

параметры выводимого списка (можно не указывать)

Выходные данные

список записей стран, актуальных и последних (active=true, last=true).

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

Объект getAllCountryListRequest

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

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры запрашиваемого списка.	bs:ListOptions	0..1

Объект ..Request/listOptions

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

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

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

Объект getAllCountryListResponse

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

Поле	Описание	Тип данных	Обязательность
countryList	Объект, содержащий запрашиваемый список стран.	ikar:CountryList	1

Объект ..Response/countryList

Объект содержит список стран

Поле	Описание	Тип данных	Обязательность
country	Объект содержит информацию о стране.	ikar:Country	0..*

Атрибуты списка countryList

Атрибут	Описание	Тип данных	Обязательность
count	Размер списка, передаваемого в ответе на запрос.	xs:int	1
total	Размер всего списка, удовлетворяющего запросу.	xs:long	1
offset	Смещение первого элемента передаваемого списка во всем списке результатов, удовлетворяющих запросу.	xs:int	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

Описание ошибок

Ошибка	Описание
InternalServiceFault	Внутренняя ошибка сервиса.
IncorrectRequestFault	Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос списка из 3 стран с нулевым смещением от начала списка.

<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>

Ответ на запрос

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
  <SOAP-ENV:Body xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getAllCountryListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                  xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar" 
                                  xmlns:ws="http://api.vetrf.ru/schema/cdm/ikar/ws-definitions">
      <ikar:countryList count="10" total="251" offset="0">
        <ikar:country>
          <bs:uuid>388beb78-47c5-1f4c-8875-aa5ebf3a3671</bs:uuid>
          <bs:guid>c04b237c-c00c-af9b-92f0-9eeb76b64544</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2012-08-09T09:48:36+04:00</bs:createDate>
          <bs:updateDate>2012-08-09T09:48:36+04:00</bs:updateDate>
          <ikar:name>Абхазия</ikar:name>
          <ikar:fullName>Республика Абхазия</ikar:fullName>
          <ikar:englishName>Abkhazia</ikar:englishName>
          <ikar:code>AB</ikar:code>
          <ikar:code3>ABH</ikar:code3>
        </ikar:country>
        <ikar:country>
          <bs:uuid>0ec5cc2a-3c49-38f0-4e9e-4fe564f0c5ce</bs:uuid>
          <bs:guid>22e26f60-2b2b-12f2-96be-ff43d3158d1b</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2012-08-09T09:48:36+04:00</bs:createDate>
          <bs:updateDate>2012-08-09T09:48:36+04:00</bs:updateDate>
          <ikar:name>Австрия</ikar:name>
          <ikar:fullName>Австрийская Республика</ikar:fullName>
          <ikar:englishName>Austria</ikar:englishName>
          <ikar:code>AT</ikar:code>
          <ikar:code3>AUT</ikar:code3>
        </ikar:country>
      </ikar:countryList>
    </ws:getAllCountryListResponse>
  </SOAP-ENV:Body>
</soapenv:Envelope>