GetPurposeByUuid

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

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

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

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

argc (http://api.vetrf.ru/schema/cdm/argus/common)
- argc:Purpose

xs (http://www.w3.org/2001/XMLSchema)

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

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

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

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

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

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