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

Текущая версия на 10:35, 15 декабря 2016

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

Операция 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	Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос списка из 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>

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

<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>8e2bf5a6-5959-7f95-b044-f6137cc93b6d</bs:uuid>
               <bs:guid>f133f1fd-7fa2-da91-d069-24df64749742</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:englishName>Australia</ikar:englishName>
               <ikar:code>AU</ikar:code>
               <ikar:code3>AUS</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:country>
               <bs:uuid>9860ea6c-d599-a234-ee96-e1b4b563b716</bs:uuid>
               <bs:guid>3d8255f1-48eb-7932-b951-c91a1d65aead</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>Azerbaijan</ikar:englishName>
               <ikar:code>AZ</ikar:code>
               <ikar:code3>AZE</ikar:code3>
            </ikar:country>
            <ikar:country>
               <bs:uuid>3e827394-0523-c627-fb53-9e03150ac91e</bs:uuid>
               <bs:guid>0b0d6a33-4134-b480-cf09-a28525352fe4</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>Albania</ikar:englishName>
               <ikar:code>AL</ikar:code>
               <ikar:code3>ALB</ikar:code3>
            </ikar:country>
            <ikar:country>
               <bs:uuid>a8614ae6-edc2-91c4-b106-8965977d8b2d</bs:uuid>
               <bs:guid>4c088512-3a0d-50e7-3e20-ab3be8848e7f</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>Algeria</ikar:englishName>
               <ikar:code>DZ</ikar:code>
               <ikar:code3>DZA</ikar:code3>
            </ikar:country>
            <ikar:country>
               <bs:uuid>8cdcf362-fc22-ff30-b0bc-ab820bc4505d</bs:uuid>
               <bs:guid>67fd2b8e-fc45-ab08-2804-8ecae418e285</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:englishName>American Samoa</ikar:englishName>
               <ikar:code>AS</ikar:code>
               <ikar:code3>ASM</ikar:code3>
            </ikar:country>
            <ikar:country>
               <bs:uuid>9f029647-2ab9-d863-2b46-a0c42de09530</bs:uuid>
               <bs:guid>ec91f50a-6ebd-27e1-e60f-1bd1df76210b</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:englishName>Anguilla</ikar:englishName>
               <ikar:code>AI</ikar:code>
               <ikar:code3>AIA</ikar:code3>
            </ikar:country>
            <ikar:country>
               <bs:uuid>f05d40dd-62f8-7f79-84f7-aa2c221fd141</bs:uuid>
               <bs:guid>2a05396f-08e2-b148-6b9d-c65df4f3d597</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>Angola</ikar:englishName>
               <ikar:code>AO</ikar:code>
               <ikar:code3>AGO</ikar:code3>
            </ikar:country>
            <ikar:country>
               <bs:uuid>d2f68f20-bd21-52ac-ec6a-d42fcc0afeb3</bs:uuid>
               <bs:guid>3d6ba798-3184-28f4-a6a1-0fa2a3aadee5</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>Andorra</ikar:englishName>
               <ikar:code>AD</ikar:code>
               <ikar:code3>AND</ikar:code3>
            </ikar:country>
         </ikar:countryList>
      </ws:getAllCountryListResponse>
   </SOAP-ENV:Body>
</soapenv:Envelope>