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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 37: Строка 37:
==Данные ответа==
==Данные ответа==


В ответе возвращаются данные страны из реестра РСХН. Метод возвращает последнюю версию записию
В ответе возвращаются данные страны из реестра РСХН. Метод возвращает последнюю версию записи.


===Объект getCountryByUuidResponse===
===Объект getCountryByUuidResponse===

Версия 12:03, 19 октября 2016

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

Метод разработан для получения полной информации о стране из реестра РСХН по её идентификатору. Возвращает запись той версии, которая значится под указанным UUID, то есть запись может быть не последней и не актуальной.

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

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

Объект getCountryByGuidRequest

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

Поле Описание Тип данных Обязательность
UUID Глобальный идентификатор страны в реестре РСХН bs:UUID 1


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

В ответе возвращаются данные страны из реестра РСХН. Метод возвращает последнюю версию записи.

Объект getCountryByUuidResponse

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

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

Объект ..Response/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

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

Получение данных Австралии по её идентификатору.

<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:getCountryByUuidRequest>
         <base:guid>8e2bf5a6-5959-7f95-b044-f6137cc93b6d</base:guid>
      </ws:getCountryByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope>