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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
Строка 63: Строка 63:
! Тип
! Тип
! Обязат.
! Обязат.
! Описание
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
|-
|-
|1
|001
|style="font-weight: bold; font-family: Courier;" |<ws:getSubProductByUuidResponse>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByUuidResponse>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|2
|002
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:subProduct>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProduct>'''}}
|[[Product_v2.0|dt:Product]]
|[[Product_v2.0|dt:Product]]
|[1..1]
|[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;">Вид продукции.
|style="font-family: Courier;" |
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* третий уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|-
|3
|003
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[[UUID|bs:UUID]]
|[1..1]
|[1..1]
|Идентификатор версии вида продукции.
| style="width:52em;"| Идентификатор версии вида продукции.
|style="font-family: Courier;" |<bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
|-
|-
|4
|004
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|Глобальный идентификатор вида продукции.
| style="width:52em;"| Глобальный идентификатор вида продукции.
|style="font-family: Courier;" |<bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
|-
|-
|5
|005
|style="font-weight: bold; font-family: Courier;" |······<bs:active>
|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]
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|[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 - запись активна;
* true - запись активна;
* false - запись не активна.
* false - запись не активна.</div>
|style="font-family: Courier;" |<bs:active>true</bs:active>
</div>
|-
|-
|6
|006
|style="font-weight: bold; font-family: Courier;" |······<bs:last>
|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]
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|[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 - да;
* true - да;
* false - нет.  
* false - нет. </div>
|style="font-family: Courier;" |<bs:last>true</bs:last>
</div>
|-
|-
|7
|007
|style="font-weight: bold; font-family: Courier;" |······<bs:status>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|100}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|[[VersionStatus|bs:VersionStatus]]
|[[VersionStatus|bs:VersionStatus]]
|[1..1]
|[1..1]
|Статус версии записи.
| style="width:52em;"| Статус версии записи.
|style="font-family: Courier;" |<bs:status>100</bs:status>
|-
|-
|8
|008
|style="font-weight: bold; font-family: Courier;" |······<bs:createDate>
|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]
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
|[1..1]
|Дата создания записи.
| style="width:52em;"| Дата создания записи.
|style="font-family: Courier;" |<bs:createDate>2017-07-07T12:00:00</bs:createDate>
|-
|-
|9
|009
|style="font-weight: bold; font-family: Courier;" |······<bs:updateDate>
|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]
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
|[1..1]
|Дата изменения записи.
| style="width:52em;"| Дата изменения записи.
|style="font-family: Courier;" |<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
|-
|-
|10
|010
|style="font-weight: bold; font-family: Courier;" |······<bs:previous>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|[[UUID|bs:UUID]]
|[[UUID|bs:UUID]]
|[0..1]
|[0..1]
|Идентификатор предыдущей версии записи.
| style="width:52em;"| Идентификатор предыдущей версии записи.
|style="font-family: Courier;" |<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
|-
|-
|11
|011
|style="font-weight: bold; font-family: Courier;" |······<bs:next>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}next>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}next>'''}}
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[0..1]
|[0..1]
|Идентификатор следующей версии записи.
| style="width:52em;"| Идентификатор следующей версии записи.
|style="font-family: Courier;" |<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
|-
|-
|12
|013
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:name>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|мясо птицы}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|[[String255|bs:String255]]
|[[String255|bs:String255]]
|[1..1]
|[1..1]
|Название вида продукции.
| style="width:52em;"| Название вида продукции.
|style="font-family: Courier;" |&lt;dt:name>мясо птицы</dt:name>
|-
|-
|13
|014
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:code>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|0207}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|[[String255|bs:String255]]
|[[String255|bs:String255]]
|[1..1]
|[1..1]
|Код ТН ВЭД вида продукции.
| style="width:52em;"| Код ТН ВЭД вида продукции.
|style="font-family: Courier;" |&lt;dt:code>0207</dt:code>
|-
|-
|14
|015
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:productGuid
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}productGuid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}productGuid>'''}}
|[[UUID|bs:UUID]]
|[[UUID|bs:UUID]]
|[1..1]
|[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;">Глобальный идентификатор продукции.
|style="font-family: Courier;" |&lt;dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* второй уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|-
|15
|016
|style="font-weight: bold; font-family: Courier;" |···</dt:subProduct>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|16
|017
|style="font-weight: bold; font-family: Courier;" |</ws:getSubProductByUuidResponse>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByUuidResponse>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|}
|}

Текущая версия на 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>