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

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


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 17: Строка 17:
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getPurposeByUuidRequest|Входные данные]]===
* уникальный идентификатор версии записи.
===[[#Объект getPurposeByUuidResponse|Выходные данные]]===
* данные об указанном назначении груза.


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


===Объект getPurposeByGuidRequest===
===Объект getPurposeByUuidRequest===


Корневой объект запроса. В нём указан глобальный идентификатор, по которому производится поиск назначения груза.
Корневой объект запроса. В нём указан идентификатор версии записи, по которому производится поиск назначения груза.


{| class="wikitable"
{| class="wikitable"
Строка 28: Строка 34:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''UUID''' || Глобальный идентификатор назначения записи, по которому производится поиск записи  || [[UUID|bs:UUID]] || 1
| '''UUID''' || Уникальный идентификатор версии записи о назначении, по которому производится поиск.|| [[UUID|bs:UUID]] || 1
|}
|}


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


===Объект getPurposeByGuidResponse===
===Объект getPurposeByUuidResponse===


Корневой элемент ответа. Содержит информацию о цели назначения груза.
Корневой элемент ответа. Содержит информацию о цели назначения груза.
Строка 41: Строка 47:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Response/purpose|'''purpose''']] || Сущность, описывающая назначение груза || [[Purpose|argc:Purpose]] || 1
| [[#Объект ..Response/purpose|'''purpose''']] || Сущность, описывающая назначение груза. || [[Purpose|argc:Purpose]] || 1
|}
|}


===Объект [[#Объект getPurposeByUuidResponse|..Response]]/'''purpose'''===


===Объект [[#Объект getPurposeByGuidResponse|..Response]]/'''purpose'''===
Объект содержит данные о назначении груза.


Объект содержит данные о назначении груза.
{{Ветис.API Dictionary Purpose|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
|-
| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''createDate''' || Дата создания записи о продукции в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|-
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
|-
| '''name''' || Название цели || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''IncorrectRequestFault''' || Некорректный  запрос.   Происходит  в  случае,  если  запрос  не  соответствует  требованиям указанным в xsd.
|-
| '''forSubstandard''' || Назначение для некачественных грузов || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 0..1
|-
|-
| '''EntityNotFoundFault''' || Объект с заданными параметрами не найден в базе.
|}
|}


==Пример запроса==
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос данных о назначении "Для личного потребления"
Запрос данных о назначении "Для личного потребления".
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Строка 83: Строка 76:
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"  
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"  
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Header/>
  <soapenv:Body>
  <soapenv:Body>
      <ws:getPurposeByGuidRequest>
    <ws:getPurposeByGuidRequest>
        <base:uuid>fedcef24-053c-11e1-99b4-d8d385fbc9e8</base:uuid>
      <base:uuid>fedcef24-053c-11e1-99b4-d8d385fbc9e8</base:uuid>
      </ws:getPurposeByGuidRequest>
    </ws:getPurposeByGuidRequest>
  </soapenv:Body>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</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/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getPurposeByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                                xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
                                xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
      <com:purpose>
        <bs:uuid>fedcef24-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
        <bs:guid>5b91af60-e089-11e1-bcf3-b499babae7ea</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2009-07-22T18:30:06+03:00</bs:createDate>
        <bs:updateDate>2009-07-22T18:30:06+03:00</bs:updateDate>
        <com:name>для личного потребления</com:name>
      </com:purpose>
    </ws:getPurposeByUuidResponse>
  </S:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>
[[Category:Ветис.API]]
[[Category:DictionaryService]]
[[Category:Реестры]]

Текущая версия на 09:25, 16 декабря 2016

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

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

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

  • bs (http://api.vetrf.ru/schema/cdm/base)

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

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

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

  • данные об указанном назначении груза.

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

Объект getPurposeByUuidRequest

Корневой объект запроса. В нём указан идентификатор версии записи, по которому производится поиск назначения груза.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи о назначении, по которому производится поиск. bs:UUID 1

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

Объект getPurposeByUuidResponse

Корневой элемент ответа. Содержит информацию о цели назначения груза.

Поле Описание Тип данных Обязательность
purpose Сущность, описывающая назначение груза. argc:Purpose 1

Объект ..Response/purpose

Объект содержит данные о назначении груза.

Поле Описание Тип Обязательность
UUID Идентификатор версии записи о назначении груза в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор назначения груза в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активна ли запись. xs:boolean 1
last Флаг, указывающий на то, является ли запись последней. xs:boolean 1
status Статус версии записи. xs:string 1
createDate Дата создания записи о назначении груза в реестре Россельхознадзора. xs:dateTime 1
updateDate Дата последнего обновления записи в реестре Россельхознадзора. xs:dateTime 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
next Идентификатор следующей версии записи. bs:UUID 0..1
name Название цели (назначения груза). xs:string 0..1

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
EntityNotFoundFault Объект с заданными параметрами не найден в базе.

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

Запрос данных о назначении "Для личного потребления". 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getPurposeByGuidRequest>
      <base:uuid>fedcef24-053c-11e1-99b4-d8d385fbc9e8</base:uuid>
    </ws:getPurposeByGuidRequest>
  </soapenv:Body>
</soapenv:Envelope>


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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getPurposeByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                 xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 
                                 xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
      <com:purpose>
        <bs:uuid>fedcef24-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
        <bs:guid>5b91af60-e089-11e1-bcf3-b499babae7ea</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2009-07-22T18:30:06+03:00</bs:createDate>
        <bs:updateDate>2009-07-22T18:30:06+03:00</bs:updateDate>
        <com:name>для личного потребления</com:name>
      </com:purpose>
    </ws:getPurposeByUuidResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetPurposeByUuid&oldid=19240