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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 88: Строка 88:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| UUID || Идентификатор версии записи о стране в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''UUID''' || Идентификатор версии записи о стране в реестре РСХН || [[UUID|bs:UUID]] || 1
|-
|-
| GUID || Глобальный идентификатор страны в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный идентификатор страны в реестре РСХН || [[UUID|bs:UUID]] || 1
|-
|-
| active || Флаг, указывающий активна ли запись || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
| '''active''' || Флаг, указывающий активна ли запись || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
|-
| last || Флаг, указывающий, является ли версия записи последней || [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
| '''status''' || Статус записи || [[VersionStatus|bs:VersionStatus]] || 1
|-
|-
| createDate || Дата создания записи || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 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
| '''updateDate''' || Дата обновления записи || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
|-
|-
| name || Название страны (например, Белоруссия) || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''name''' || Название страны (например, Белоруссия) || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
|-
| fullName || Полное название страны (например, Республика Беларусь) || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''fullName''' || Полное название страны (например, Республика Беларусь) || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
|-
| englishName || Название страны на английском языке ||[https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''englishName''' || Название страны на английском языке ||[https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
|-
| code || Двухбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''code''' || Двухбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
|-
| code3 || Трёхбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''code3''' || Трёхбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|}
|}

Версия 21:33, 28 августа 2016

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

Метод разработан для получения списка всех стран мира.

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

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

Объект 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 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
name Название страны (например, Белоруссия) xs:string 1
fullName Полное название страны (например, Республика Беларусь) xs:string 1
englishName Название страны на английском языке xs:string 1
code Двухбуквенный код страны xs:string 1
code3 Трёхбуквенный код страны xs:string 1