GetUnitByUuid

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

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

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

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

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

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

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

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

  • данные версии записи единицы измерения.

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

Объект getUnitByUuidRequest

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

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

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

Объект getUnitByUuidResponse

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

Поле Описание Тип данных Обязательность
unit Сущность, описывающая единицу измерения. argc:Unit 1

Объект ..Response/unit

Объект содержит данные о единице измерения

Поле Описание Тип Обязательность
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 1
fullName Полное название единицы измерения. xs:string 1
commonUnitGuid Глобальный идентификатор базовой единицы измерения.
  • Например, для тонны базовой единицей измерения является килограмм.
bs:UUID 1
factor Коэффициент относительно базовой единицы измерения.
  • Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.
xs:integer 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:getUnitByUuidRequest>
      <base:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</base:uuid>
    </ws:getUnitByUuidRequest>
  </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:getUnitByUuidResponse 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:unit>
        <bs:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
        <bs:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
        <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
        <com:name>кг</com:name>
        <com:fullName>кг</com:fullName>
        <com:commonUnitGuid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</com:commonUnitGuid>
        <com:factor>1</com:factor>
      </com:unit>
    </ws:getUnitByUuidResponse>
  </S:Body>
</soapenv:Envelope>