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

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


Метод позволяет получить информацию о версии запис о виде продукции по её идентификатору.
Операция '''GetSubProductByUuid''' предназначена для получения информации о конкретной версии записи вида продукции по её уникальному идентификатору. Выполнение операции заканчивается либо  возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной  (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 9: Строка 9:
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:date]
** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбец}}
{{столбец}}
*  [[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:ProductType]]
** [[ProductType|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]]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getSubProductByUuidRequest|Входные данные]]===
* уникальный идентификатор версии вида продукции.
===[[#Объект getSubProductByUuidResponse|Выходные данные]]===
* данные о виде продукции.


==Данные запроса==
==Данные запроса==
Строка 23: Строка 29:
===Объект getSubProductByUuidRequest===
===Объект getSubProductByUuidRequest===


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


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


Строка 56: Строка 62:
</div> -->
</div> -->


===Объект getProductByUuidResponse===
===Объект getSubProductByUuidResponse===


Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
Строка 64: Строка 70:
! Поле !! Описание !! Тип !! Обязательность
! Поле !! Описание !! Тип !! Обязательность
|-
|-
| '''UUID''' || Идентификатор версии записи о продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
| [[GetSubProductByUuid#Объект ..Response/subProduct|'''subProduct''']] || Объект содержит описание вида продукции. || [[SubProduct|prod:SubProduct]] || 1
|-
|}
| '''GUID''' || Глобальный идентификатор продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
 
|-
===Объект [[GetSubProductByUuid#Объект getSubProductByUuidResponse|..Response]]/'''subProduct'''===
| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
 
|-
{{Ветис.API ProductService Subproduct|1}}
| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
 
|-
==Описание ошибок==
| '''createDate''' || Дата создания записи о продукции в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1
 
|-
{| class="wikitable"
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 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
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
|-
| '''code''' || Код ТН ВЭД продукции || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.  
|-
|-
| '''productGuid''' || Идентификатор продукции (второй уровень иерархии справочника продукции) || [[Product|prod:Product]] || 1
| '''EntityNotFoundFault''' || Объект с заданными параметрами не найден в базе.
 
|}
|}


==Пример запроса==
==Пример запроса==
<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">
Строка 99: Строка 101:
   <soapenv:Body>
   <soapenv:Body>
       <ws:getSubProductByUuidRequest>
       <ws:getSubProductByUuidRequest>
         <base:uuid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:uuid>
         <base:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</base:uuid>
       </ws:getSubProductByUuidRequest>
       </ws:getSubProductByUuidRequest>
   </soapenv:Body>
   </soapenv:Body>
</soapenv:Envelope
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</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:getSubProductByUuidResponse 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:getSubProductByUuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
[[Category:Ветис.API]]
[[Category:ProductService]]
[[Category:Реестры]]

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

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

Операция GetSubProductByUuid предназначена для получения информации о конкретной версии записи вида продукции по её уникальному идентификатору. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

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

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

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

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

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

Объект getSubProductByUuidRequest

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

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

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

Объект getSubProductByUuidResponse

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

Поле Описание Тип Обязательность
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
next Идентификатор следующей версии записи. 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:getSubProductByUuidRequest>
         <base:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</base:uuid>
      </ws:getSubProductByUuidRequest>
   </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:getSubProductByUuidResponse 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:getSubProductByUuidResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetSubProductByUuid&oldid=19263