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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показано 8 промежуточных версий 2 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 17: Строка 17:
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getUnitByGuidRequest|Входные данные]]===
*глобальный идентификатор единицы измерения.
===[[#Объект getUnitByGuidResponse |Выходные данные]]===
* данные о единице измерения с указанным идентификатором.


==Данные запроса==
==Данные запроса==
Строка 28: Строка 34:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''GUID''' || Глобальный идентификатор единицы измерения, по которому производится поиск записи  || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный идентификатор единицы измерения, по которому производится поиск записи. || [[UUID|bs:UUID]] || 1
|}
|}


Строка 35: Строка 41:
===Объект getUnitByGuidResponse===
===Объект getUnitByGuidResponse===


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


{| class="wikitable"
{| class="wikitable"
Строка 41: Строка 47:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Response/unit|'''unit''']] || Сущность, описывающая единицу измерения || [[Unit|argc:Unit]] || 1
| [[#Объект ..Response/unit|'''unit''']] || Сущность, описывающая единицу измерения. || [[Unit|argc:Unit]] || 1
|}
|}


===Объект [[#Объект getUnitByGuidResponse|..Response]]/'''unit'''===


===Объект [[#Объект getUnitByGuidResponse|..Response]]/'''unit'''===
Объект содержит данные о единице измерения.


Объект содержит данные о назначении груза.
{{Ветис.API Dictionary Unit}}


==Описание ошибок==
{| class="wikitable"
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип !! Обязательность
! Ошибка !! Описание
|-
|-
| '''UUID''' || Идентификатор версии записи о единице измерения в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
|-
| '''GUID''' || Глобальный идентификатор единицы измерения в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''IncorrectRequestFault''' || Некорректный  запрос.  Происходит  в   случае,  если  запрос  не  соответствует  требованиям указанным в xsd.
|-
|-
| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
| '''EntityNotFoundFault''' || Объект с заданными параметрами не найден в базе.
|-
| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''createDate''' || Дата создания записи о единице измерения в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Краткое название единицы измерения || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''fullName''' || Полное название единицы измерения || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''commonUnitGuid''' || Глобальный идентификатор базовой единицы измерения. Например, для центнера, тонны, тыс.тонн базовой единицей измерения является килограмм || [[UUID|bs:UUID]] || 1
|-
| '''factor''' || Коэффициент относительно базовой единицы измерения. Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.  || [https://www.w3.org/TR/xmlschema-2/#integer xs:integer] || 1
|}
|}


==Пример запроса==
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос данных о килограмме
Запрос данных о килограмме.
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Строка 86: Строка 76:
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"  
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"  
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Header/>
  <soapenv:Body>
  <soapenv:Body>
      <ws:getUnitByGuidRequest>
    <ws:getUnitByGuidRequest>
        <base:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</base:guid>
      <base:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</base:guid>
      </ws:getUnitByGuidRequest>
    </ws:getUnitByGuidRequest>
  </soapenv:Body>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getUnitByGuidResponse 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:getUnitByGuidResponse>
  </S:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>
[[Category:Ветис.API]]
[[Category:DictionaryService]]
[[Category:Реестры]]

Текущая версия на 09:26, 16 декабря 2016

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

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

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

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

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

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

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

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

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

Объект getUnitByGuidRequest

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

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

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

Объект getUnitByGuidResponse

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

Поле Описание Тип данных Обязательность
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
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:getUnitByGuidRequest>
      <base:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</base:guid>
    </ws:getUnitByGuidRequest>
  </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:getUnitByGuidResponse 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:getUnitByGuidResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetUnitByGuid&oldid=19244