GetUnitByGuid v2.0

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

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

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

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getUnitByGuidResponse>
2 ···<dt:unit> dt:Unit [1..1] Единица измерения
3 ······<bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения <bs:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
4 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения <bs:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</bs:guid>
5 ······<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
<bs:active>true</bs:active>
6 ······<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
<bs:last>true</bs:last>
7 ······<bs:status> bs:VersionStatus [1..1] Статус версии единицы измерения <bs:status>100</bs:status>
8 ······<bs:createDate> xs:DateTime [1..1] Дата создания единицы измерения <bs:createDate>2017-07-07T12:00:00</bs:createDate>
9 ······<bs:updateDate> xs:DateTime [1..1] Дата изменения единицы измерения <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
10 ······<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра единиц измерения <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
11 ······<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра единиц измерения <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
12 ······<dt:name> bs:String255 [1..1] Наименование единицы измерения <dt:name>кг</dt:name>
13 ······<dt:fullName> bs:String255 [1..1] Полное наименование единицы измерения <dt:fullName>килограмм</dt:fullName>
14 ······<dt:commonUnitGuid> bs:UUID [1..1] Глобальный идентификатор базовой единицы измерения
  • Например, для тонны базовая единица - кг
<dt:commonUnitGuid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</dt:commonUnitGuid>
15 ······<dt:factor> xs:integer [1..1] Коэффициент относительно базовой единицы измерения
  • Например, для тонны = 1000
<dt:factor>1</dt:factor>
16 ···</dt:unit>
17 </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>