GetCountryChangesList: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 68: | Строка 68: | ||
* В случае, если компонента endDate не указана, то используется текущая дата. | * В случае, если компонента endDate не указана, то используется текущая дата. | ||
|| [[dataInterval|bs:DataInterval]] || 0..1 | || [[dataInterval|bs:DataInterval]] || 0..1 | ||
|} | |||
==Данные ответа== | |||
===Объект getCountryChangesListResponse=== | |||
Корневой объект ответа. Содержит список возвращаемых стран. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| [[#Объект ..Response/|'''countryList''']] || Объект, содержащий запрашиваемый список стран || [[CountryList|ikar:CountryList]] || 1 | |||
|} | |||
===Объект [[#Объект getCountryChangesListResponse|..Response]]/countryList=== | |||
Объект содержит список стран | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| [[#Объект ..Response/countryList/country|'''country''']] || Объект содержит информацию о стране || [[Country|ikar:Country]] || 1 | |||
|} | |||
===Объект [[#Объект getCountryChangesListResponse|..Response]]/[[#Объект ..Response/countryList|countryList]]/country=== | |||
Объект содержит информацию о стране. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип данных !! Обязательность | |||
|- | |||
| '''UUID''' || Идентификатор версии записи о стране в реестре РСХН || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный идентификатор страны в реестре РСХН || [[UUID|bs:UUID]] || 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 | |||
|- | |||
| '''status''' || Статус записи || [[VersionStatus|bs:VersionStatus]] || 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 | |||
|- | |||
| '''name''' || Название страны (например, Белоруссия) || [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 | |||
|- | |||
| '''code''' || Двухбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|- | |||
| '''code3''' || Трёхбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|} | |} | ||
Версия 23:21, 28 августа 2016
Общие сведения
Метод позволяет получить историю изменений в списке стран. Выполнение операции заканчивается возвратом списка стран. В список попадают записи, дата изменения которых попадает во временной интервал, указанный в запросе. Метод поддерживает возможность частичного вывода списка.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект getCountryChangesList
Корневой объект запроса. Содержит параметры запрашиваемого списка.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| listOptions | Параметры возвращаемого списка: количество элементов и смещение | bs:ListOptions | 0..1 |
| updateDateinterval | Интервал дат, за который запрашиваются изменения | bs:DateInterval | 0..1 |
Объект ..Request/listOptions
Объект содержит два параметра запрашиваемого списка: количество выводимых объектов и смещение относительно начала.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| count | Количество значений в списке
|
xs:nonNegativeInteger | 0..1 |
| offset | Смещение в списке относительно начала | xs:nonNegativeInteger | 0..1 |
Объект ..Request/updateDateInterval
Объект содержит сведения об интервале времени, за который необходимо получить обновления.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| beginDate | Дата, начиная с которой пользователь получит историю изменений записей стран. | bs:DataInterval | 1 |
| endDate | Конец временного интервала.
|
bs:DataInterval | 0..1 |
Данные ответа
Объект getCountryChangesListResponse
Корневой объект ответа. Содержит список возвращаемых стран.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| 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 |
