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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
м
 
(не показаны 23 промежуточные версии 2 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


Метод GetCountryByUuid разработан для получения полной информации о стране из реестра Росельхознадзора по её идентификатору. Возвращает запись той версии, которая значится под указанным UUID, то есть запись может быть не последней и не актуальной.
Операция GetCountryByUuid предназначена для получения полной информации о стране из реестра Росcельхознадзора по её идентификатору. Выполнение операции заканчивается либо возвратом объекта страны, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. Операция возвращает запись той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (т.е. возможно, что active=false, last=false).


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 9: Строка 9:
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
** [http://www.w3.org/TR/xmlschema-2/#date xs:date]
** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
** [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
** [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
Строка 20: Строка 20:
** [[VersionStatus|bs:VersionStatus]]
** [[VersionStatus|bs:VersionStatus]]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getCountryByUuidRequest|Входные данные]]===
* уникальный идентификатор версии записи.
===[[#Объект getCountryByUuidResponse|Выходные данные]]===
* запись с данными страны, у которой UUID равен указанному идентификатору. Запись может быть не последней и не актуальной.


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


===Объект getCountryByGuidRequest===
===Объект getCountryByUuidRequest===


Корневой объект запроса. Содержит идентификатор страны.
Корневой объект запроса. Содержит идентификатор страны.
Строка 30: Строка 36:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''UUID''' || Глобальный идентификатор страны в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
| '''UUID''' || Идентификатор версии записи страны в реестре Россельхознадзора (в системе Икар). || [[UUID|bs:UUID]] || 1
|}
|}


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


В ответе возвращаются данные страны из реестра Россельхознадзора. Метод возвращает последнюю версию записи.
В ответе возвращаются данные страны из реестра Россельхознадзора (в системе Икар). Метод возвращает версию записи с указанным UUID, необязательно последнюю и/или актуальную.


===Объект getCountryByUuidResponse===
===Объект getCountryByUuidResponse===
Строка 48: Строка 54:
|}
|}


===Объект [[#Объект getCountryByUuidResponse|..Response]]/country===
===Объект [[#Объект getCountryByUuidResponse|..Response]]/'''country'''===
 
{{Ветис.API Ikar Country }}


<!--Объект содержит информацию о стране.
{{Ветис.API Ikar Country|1}}


==Описание ошибок==
{| class="wikitable"
{| 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
| '''InternalServiceFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Внутренняя ошибка сервиса
|-
|-
| '''englishName''' || Название страны на английском языке ||[https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''IncorrectRequestFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Некорректный запрос. Возникает, если
* запрос не соответствует требованиям указанным в xsd;
* UUID указан в неверном формате.
|-
|-
| '''code''' || Двухбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''EntityNotFoundFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Ошибка, свидетельствующая о том, что страна с указанным идентификатором не найдена.
|-
| '''code3''' || Трёхбуквенный код страны || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|}
|}
-->


==Пример запроса==
==Пример запроса==
Строка 102: Строка 90:
</div>
</div>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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:getCountryByUuidResponse 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: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>
    </ws:getCountryByUuidResponse>
  </SOAP-ENV:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
[[Category:Ветис.API]]
[[Category:IkarService]]
[[Category:Реестры]]

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

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

Операция GetCountryByUuid предназначена для получения полной информации о стране из реестра Росcельхознадзора по её идентификатору. Выполнение операции заканчивается либо возвратом объекта страны, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. Операция возвращает запись той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (т.е. возможно, что active=false, last=false).

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

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

  • уникальный идентификатор версии записи.

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

  • запись с данными страны, у которой UUID равен указанному идентификатору. Запись может быть не последней и не актуальной.

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

Объект getCountryByUuidRequest

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

Поле Описание Тип данных Обязательность
UUID Идентификатор версии записи страны в реестре Россельхознадзора (в системе Икар). bs:UUID 1

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

В ответе возвращаются данные страны из реестра Россельхознадзора (в системе Икар). Метод возвращает версию записи с указанным UUID, необязательно последнюю и/или актуальную.

Объект 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
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
next Идентификатор следующей версии записи. 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;
  • UUID указан в неверном формате.
EntityNotFoundFault Ошибка, свидетельствующая о том, что страна с указанным идентификатором не найдена.

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

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

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