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

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


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 14: Строка 14:
*  [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/production|prod]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/production</nowiki>)
*  [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/production|prod]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/production</nowiki>)
** [[Product|prod:Product]]
** [[Product|prod:Product]]
** [[ProductType|prod:SubProduct]]
** [[SubProduct|prod:SubProduct]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getSubProductByGuidRequest|Входные данные]]===
* глобальный уникальный идентификатор вида продукции.
===[[#Объект getSubProductByGuidResponse|Выходные данные]]===
* данные запрошенного вида продукции.


==Данные запроса==
==Данные запроса==
Строка 29: Строка 35:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''GUID''' || Уникальный идентификатор версии записи продукции в реестре РСХН. || [[UUID|bs:UUID]] || 1
| '''GUID''' || Уникальный глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
|}


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


===Объект getProductByGuidResponse===
===Объект getSubProductByGuidResponse===


Корневой объект ответа. Содержит информацию о запрашиваемом виде продукции.
Корневой объект ответа. Содержит информацию о запрашиваемом виде продукции.
Строка 42: Строка 48:
! Поле !! Описание !! Тип !! Обязательность
! Поле !! Описание !! Тип !! Обязательность
|-
|-
| [[#Объект ..Response/subproduct|'''subproduct''']] || Вид продукции || [[SubProduct|prod:SubProduct]] || 1
| [[#Объект ..Response/subProduct|'''subProduct''']] || Вид продукции. || [[SubProduct|prod:SubProduct]] || 1
|}
|}


===Объект [[#Объект getSubProductByGuidResponse|..Response]]/'''subproduct'''===
===Объект [[#Объект getSubProductByGuidResponse|..Response]]/'''subProduct'''===


Объект описывает свойства вида продукции.
Объект описывает свойства вида продукции.
{{Ветис.API ProductService Subproduct}}
==Описание ошибок==


{| 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/#date xs:date] || 1
|-
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 0..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
|-
| '''code''' || Код ТН ВЭД продукции || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''productGuid''' || Идентификатор продукции (второй уровень иерархии справочника продукции) || [[Product|prod:Product]] || 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">
Строка 85: Строка 78:
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"  
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/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:getSubProductByGuidRequest>
    <ws:getSubProductByGuidRequest>
        <base:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:guid>
      <base:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</base:guid>
      </ws:getSubProductByGuidRequest>
    </ws:getSubProductByGuidRequest>
  </soapenv:Body>
  </soapenv:Body>
</soapenv:Envelope
</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:getSubProductByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                                    xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production"
                                    xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
      <pro:subProduct>
        <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
        <bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate>
        <bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate>
        <pro:name>мясо птицы</pro:name>
        <pro:code>0207</pro:code>
        <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
      </pro:subProduct>
    </ws:getSubProductByGuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>
[[Category:Ветис.API]]
[[Category:ProductService]]
[[Category:Реестры]]

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

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

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

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

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

  • глобальный уникальный идентификатор вида продукции.

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

  • данные запрошенного вида продукции.

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

Объект getSubProductByGuidRequest

Корневой элемент запроса. Содержит глобальный идентификатор вида продукции.

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

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

Объект getSubProductByGuidResponse

Корневой объект ответа. Содержит информацию о запрашиваемом виде продукции.

Поле Описание Тип Обязательность
subProduct Вид продукции. prod:SubProduct 1

Объект ..Response/subProduct

Объект описывает свойства вида продукции.

Поле Описание Тип Обязательность
UUID Идентификатор версии записи о продукции в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор продукции в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активна ли запись. xs:boolean 1
last Флаг, указывающий на то, является ли запись последней. xs:boolean 1
status Статус версии записи. xs:string 1
createDate Дата создания записи о продукции в реестре Россельхознадзора. xs:date 1
updateDate Дата последнего обновления записи в реестре Россельхознадзора. xs:date 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
name Название вида продукции. xs:string 1
code Код ТН ВЭД вида продукции. xs:string 1
englishName Английское название вида продукции. bs:String255 0..1
productGuid Идентификатор продукции (второй уровень иерархии справочника продукции). bs:UUID 1

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

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

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

Запрос данных о виде продукции. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getSubProductByGuidRequest>
      <base:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</base:guid>
    </ws:getSubProductByGuidRequest>
  </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:getSubProductByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                    xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production" 
                                    xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
      <pro:subProduct>
        <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
        <bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate>
        <bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate>
        <pro:name>мясо птицы</pro:name>
        <pro:code>0207</pro:code>
        <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
      </pro:subProduct>
    </ws:getSubProductByGuidResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetSubProductByGuid&oldid=19274