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

Версия 14:11, 6 июля 2016

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

Метод позволяет получить информацию о версии запис о виде продукции по её идентификатору.

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

xs (http://www.w3.org/2001/XMLSchema)

prod (http://api.vetrf.ru/schema/cdm/argus/production)
- prod:Product
- prod:ProductType
bs (http://api.vetrf.ru/schema/cdm/base)
- bs:UUID

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

Объект getSubProductByUuidRequest

Корневой элемент запроса.

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

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

Объект getProductByUuidResponse

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

Поле	Описание	Тип	Обязательность
UUID	Идентификатор версии записи о продукции в реестре РСХН	bs:UUID	1
GUID	Глобальный идентификатор продукции в реестре РСХН	bs:UUID	1
active	Флаг, указывающий на то, активна ли запись.	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
productGuid	Идентификатор продукции (второй уровень иерархии справочника продукции)	prod:Product	1

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

Запрос данных о продукции "Готовые мясные продукты"

<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>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:uuid>
      </ws:getSubProductByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope

@@ Строка 31: / Строка 31: @@
 | '''UUID''' || Уникальный идентификатор версии записи продукции в реестре РСХН. || [[UUID|bs:UUID]] || 1
 |}
+==Данные ответа==
+<!--- div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
+Структура данных ответа в формате ХML.
+<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>
+            <bs:guid>{bs:UUID}</bs:guid>
+            <bs:active>{xs:boolean}</bs:active>
+            <bs:last>{xs:boolean}</bs:last>
+            <bs:status>{bs:VersionStatus}</bs:status>
+            <bs:createDate>{xs:dateTime}</bs:createDate>
+            <bs:updateDate>{xs:dateTime}</bs:updateDate>
+            <pro:name>{bs:String255}</pro:name>
+            <pro:code>{bs:String255}</pro:code>
+            <pro:productType>{prod:ProductType}</pro:productType>
+         </pro:product>
+      </ws:getProductByGuidResponse>
+</syntaxhighlight>
+</div>
+</div> -->
+===Объект getProductByUuidResponse===
+Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
+{| class="wikitable"
+|-
+! Поле !! Описание !! Тип !! Обязательность
+|-
+| '''UUID''' || Идентификатор версии записи о продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
+|-
+| '''GUID''' || Глобальный идентификатор продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
+|-
+| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 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
+|-
+| '''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
+|-
+| '''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 = "mw-collapsible-content">
+<syntaxhighlight lang="xml">
+<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>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:uuid>
+      </ws:getSubProductByUuidRequest>
+   </soapenv:Body>
+</soapenv:Envelope
+</syntaxhighlight>
+</div>
+</div>