GetUnitByGuid v2.0

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

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

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

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

  • глобальный идентификатор единицы измерения.

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

  • данные о единице измерения с указанным идентификатором.

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getUnitByGuidRequest>
002 ···<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
003 </ws:getUnitByGuidRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getUnitByGuidResponse>
002 ···<dt:unit> dt:Unit [1..1] Единица измерения.
003 ······<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения.
004 ······<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения.
005 ······<bs:active>true</bs:active> xs:boolean [1..1]

Описывает, является ли запись активной.

  • true - запись активна;
  • false - запись не активна.
006 ······<bs:last>true</bs:last> xs:boolean [1..1]

Описывает, является ли версия записи последней.

  • true - да;
  • false - нет.
007 ······<bs:status>100</bs:status> bs:VersionStatus [1..1] .Статус версии единицы измерения.
008 ······<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания единицы измерения.
009 ······<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения единицы измерения.
010 ······<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра единиц измерения.
011 ······<dt:name>кг</dt:name> bs:String255 [1..1] Наименование единицы измерения.
012 ······<dt:fullName>килограмм</dt:fullName> bs:String255 [1..1] Полное наименование единицы измерения.
013 ······<dt:commonUnitGuid>GUID</dt:commonUnitGuid> bs:UUID [1..1]

Глобальный идентификатор базовой единицы измерения.

  • Например, для тонны базовая единица - кг
014 ······<dt:factor>1</dt:factor> xs:integer [1..1]

Коэффициент относительно базовой единицы измерения.

  • Например, для тонны = 1000
015 ···</dt:unit>
016 </ws:getUnitByGuidResponse>

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

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

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

Запрос единицы измерения по глобальному идентификатору.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getUnitByGuidRequest>
          <bs:guid>52082c55-8628-409f-818c-80a02632c09f</bs:guid>
      </ws:getUnitByGuidRequest>
   </soapenv:Body>
</soapenv:Envelope>


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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <v2:getUnitByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
         <dt:unit>
            <bs:uuid>069796f6-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
            <bs:guid>52082c55-8628-409f-818c-80a02632c09f</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>
            <dt:name>бочка</dt:name>
            <dt:fullName>бочка</dt:fullName>
            <dt:commonUnitGuid>52082c55-8628-409f-818c-80a02632c09f</dt:commonUnitGuid>
            <dt:factor>1</dt:factor>
         </dt:unit>
      </v2:getUnitByGuidResponse>
   </soap:Body>
</soapenv:Envelope>