GetUnitByGuid v2.0: различия между версиями

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


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


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

Версия 10:21, 30 октября 2017

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getUnitByGuidRequest>
2 ···<bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения <bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid>
3 </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 Объект с заданными параметрами не найден в базе.

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

Запрос данных о килограмме.


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

Источник — http://help.vetrf.ru/index.php?title=GetUnitByGuid_v2.0&oldid=22332