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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetSubProductByUuid''' предназначена для получения информации о конк…»)
 
 
(не показано 5 промежуточных версий этого же участника)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


{{столбцы}}
{{столбцы}}
Строка 17: Строка 16:
* [[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|Выходные данные]]===
===Выходные данные===
* данные о виде продукции.
* данные о виде продукции.


==Данные запроса==
==Спецификация запроса==
 
===Объект getSubProductByUuidRequest===
 
Корневой элемент запроса. Содержит идентификатор версии записи вида продукции.
 
{| class="wikitable"
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|-
! Поле !! Описание !! Тип данных !! Обязательность
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByUuidRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Идентификатор версии вида продукции.
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* третий уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|003
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByUuidRequest>'''}}
|
|
| style="width:52em;"|
|-
|-
| '''UUID''' || Уникальный идентификатор версии записи вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
|}


==Данные ответа==
==Спецификация ответа==
 
{| class="wikitable"
<!--- div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
! #
Структура данных ответа в формате ХML.
! Название XML-элемента
<div class = "mw-collapsible-content">
! Тип
<syntaxhighlight lang="xml">
! Обязат.
<ws:getProductByUuidResponse 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:product>
|-
            <bs:uuid>{bs:UUID}</bs:uuid>
|001
            <bs:guid>{bs:UUID}</bs:guid>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByUuidResponse>'''}}
            <bs:active>{xs:boolean}</bs:active>
|
            <bs:last>{xs:boolean}</bs:last>
|
            <bs:status>{bs:VersionStatus}</bs:status>
| style="width:52em;"|
            <bs:createDate>{xs:dateTime}</bs:createDate>
|-
            <bs:updateDate>{xs:dateTime}</bs:updateDate>
|002
            <pro:name>{bs:String255}</pro:name>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProduct>'''}}
            <pro:code>{bs:String255}</pro:code>
|[[Product_v2.0|dt:Product]]
            <pro:productType>{prod:ProductType}</pro:productType>
|[1..1]
        </pro:product>
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
      </ws:getProductByGuidResponse>
<span style="white-space:nowrap; font-weight: normal;">Вид продукции.
</syntaxhighlight>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* третий уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
| style="width:52em;"| Идентификатор версии вида продукции.
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
| style="width:52em;"| Глобальный идентификатор вида продукции.
|-
|005
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Описывает, является ли запись активной.
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* true - запись активна;
* false - запись не активна.</div>
</div>
|-
|006
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Описывает, является ли версия записи последней.
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* true - да;
* false - нет. </div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|100}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|[[VersionStatus|bs:VersionStatus]]
|[1..1]
| style="width:52em;"| Статус версии записи.
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
| style="width:52em;"| Дата создания записи.
|-
|009
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
| style="width:52em;"| Дата изменения записи.
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"| Идентификатор предыдущей версии записи.
|-
|011
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}next>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}next>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"| Идентификатор следующей версии записи.
|-
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|мясо птицы}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Название вида продукции.
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|0207}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Код ТН ВЭД вида продукции.
|-
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}productGuid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}productGuid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Глобальный идентификатор продукции.
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* второй уровень иерархического справочника продукции ИС Меркурий</div>
</div>
</div>
</div> -->
===Объект getSubProductByUuidResponse===
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип !! Обязательность
|016
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByUuidResponse>'''}}
|
|
| style="width:52em;"|
|-
|-
| [[GetSubProductByUuid#Объект ..Response/subProduct|'''subProduct''']] || Объект содержит описание вида продукции. || [[SubProduct|prod:SubProduct]] || 1
|}
|}
===Объект [[GetSubProductByUuid#Объект getSubProductByUuidResponse|..Response]]/'''subProduct'''===
{{Ветис.API ProductService Subproduct|1}}


==Описание ошибок==
==Описание ошибок==
Строка 95: Строка 203:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"  
<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">
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"  
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
   <soapenv:Header/>
   <soapenv:Header/>
   <soapenv:Body>
   <soapenv:Body>
       <ws:getSubProductByUuidRequest>
       <ws:getSubProductByUuidRequest>
         <base:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</base:uuid>
         <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
       </ws:getSubProductByUuidRequest>
       </ws:getSubProductByUuidRequest>
   </soapenv:Body>
   </soapenv:Body>
Строка 114: Строка 220:
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getSubProductByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"  
      <v2:getSubProductByUuidResponse 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">
                                    xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production"  
        <dt:subProduct>
                                    xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
            <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
      <pro:subProduct>
            <bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
        <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
            <bs:active>true</bs:active>
        <bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
            <bs:last>true</bs:last>
        <bs:active>true</bs:active>
            <bs:status>100</bs:status>
        <bs:last>true</bs:last>
            <bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate>
        <bs:status>100</bs:status>
            <bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate>
        <bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate>
            <dt:name>мясо птицы</dt:name>
        <bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate>
            <dt:code>0207</dt:code>
        <pro:name>мясо птицы</pro:name>
            <dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
        <pro:code>0207</pro:code>
        </dt:subProduct>
        <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
      </v2:getSubProductByUuidResponse>
      </pro:subProduct>
  </soap:Body>
    </ws:getSubProductByUuidResponse>
  </S:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>

Текущая версия на 15:56, 27 сентября 2020

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getSubProductByUuidRequest>
002 ···<bs:uuid>UUID</bs:uuid> bs:UUID [1..1]

Идентификатор версии вида продукции.

  • третий уровень иерархического справочника продукции ИС Меркурий
003 </ws:getSubProductByUuidRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getSubProductByUuidResponse>
002 ···<dt:subProduct> dt:Product [1..1]

Вид продукции.

  • третий уровень иерархического справочника продукции ИС Меркурий
003 ······<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукции.
004 ······<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции.
005 ······<bs:active>true</bs:active> xs:boolean [1..1]

Описывает, является ли запись активной.

  • true - запись активна;
  • false - запись не активна.
006 ······<bs:last>true</bs:last> xs:boolean [1..1]

Описывает, является ли версия записи последней.

  • true - да;
  • false - нет.
007 ······<bs:status>100</bs:status> bs:VersionStatus [1..1] Статус версии записи.
008 ······<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания записи.
009 ······<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения записи.
010 ······<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи.
011 ······<bs:next>UUID</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи.
013 ······<dt:name>мясо птицы</dt:name> bs:String255 [1..1] Название вида продукции.
014 ······<dt:code>0207</dt:code> bs:String255 [1..1] Код ТН ВЭД вида продукции.
015 ······<dt:productGuid>GUID</dt:productGuid> bs:UUID [1..1]

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

  • второй уровень иерархического справочника продукции ИС Меркурий
016 ···</dt:subProduct>
017 </ws:getSubProductByUuidResponse>

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

Ошибка Описание
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:getSubProductByUuidRequest>
         <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
      </ws:getSubProductByUuidRequest>
   </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:getSubProductByUuidResponse 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: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>
            <dt:name>мясо птицы</dt:name>
            <dt:code>0207</dt:code>
            <dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
         </dt:subProduct>
      </v2:getSubProductByUuidResponse>
   </soap:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetSubProductByUuid_v2.0&oldid=30250