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

Версия 14:01, 16 ноября 2016

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

Операция GetProductItemByGuid преднзначена для получения последней актуальной (last = true, active = true) записи о номенклатуре производителя по её глобальному идентификатору. Глобальный идентификатор присваивается номенклатуре при занесении её в список с помощью метода ModifyProducerStockListOperation.

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

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

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

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

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

занесённые данные номенклатуры производителя.

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

Объект getProductItemByGuidRequest

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

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

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

Объект getProductItemByGuidResponse

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

Поле	Описание	Тип	Обязательность
productItem	Сущность, описывающая номенклатуру производителя.	prod:ProductItem	0..1

Объект ..Response/productItem

Объект содержит данные о единице номенклатуры продукции.

Поле	Описание	Тип	Обязательность
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
productType	Тип продукции (первый уровень иерархии справочника продукции).	prod:ProductType	1
product	Продукция (второй уровень иерархии справочника продукции).	prod:Product	1
subProduct	Вид продукции (третий уровень иерархии справочника продукции).	prod:SubProduct	1
correspondsToGost	Флаг, указывающий на то, соответствует ли указанная продукция ГОСТу.	xs:boolean	0..1
gost	ГОСТ.	bs:String255	0..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:getProductItemByGuidRequest>
      <base:guid>6585132b-725a-4838-9571-7a8d10d361e2</base:guid>
    </ws:getProductItemByGuidRequest>
  </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:getProductItemByGuidResponse 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:productItem>
        <bs:uuid>e1cf5ff6-6da6-4ddf-984b-a22a1ce37a7d</bs:uuid>
        <bs:guid>6585132b-725a-4838-9571-7a8d10d361e2</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2016-11-16T13:50:08+03:00</bs:createDate>
        <bs:updateDate>2016-11-16T13:50:08+03:00</bs:updateDate>
        <pro:name>Пельмени холостяцкие условно-съедобные</pro:name>
        <pro:productType>5</pro:productType>
        <pro:product>
          <bs:uuid>26b81265-a498-0a42-5b77-08da2eb03ab9</bs:uuid>
          <bs:guid>b45f20b3-9ade-342e-976f-f1f3b2567c53</bs:guid>
        </pro:product>
        <pro:subProduct>
          <bs:uuid>92302080-0972-9504-94c9-6b0028ccbdb6</bs:uuid>
          <bs:guid>80b7fc16-110c-a663-67e3-b5d9ce3f02ff</bs:guid>
        </pro:subProduct>
        <pro:correspondToGost>false</pro:correspondToGost>
        <pro:gost>ГОСТ_Р_51184-98</pro:gost>
      </pro:productItem>
    </ws:getProductItemByGuidResponse>
  </S:Body>
</soapenv:Envelope>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Метод позволяет получить последнюю запись о продукции по её глобальному идентификатору. Глобальный идентификатор продукции содержится в ветеринарных сертификатах.
+Операция '''GetProductItemByGuid''' преднзначена для получения последней актуальной (last = true, active = true) записи о номенклатуре производителя по её глобальному идентификатору. Глобальный идентификатор присваивается номенклатуре при занесении её в список с помощью метода [[ModifyProducerStockListOperation|ModifyProducerStockListOperation]].
 ===Используемые пространства имён и типы===
@@ Строка 17: / Строка 17: @@
 ** [[UUID|bs:UUID]]
 {{столбцы/конец}}
+===[[#Объект getProductItemByGuidRequest|Входные данные]]===
+* глобальный уникальный идентификатор в номенклатуре производителя.
+===[[#Объект getProductItemByGuidResponse|Выходные данные]]===
+* занесённые данные номенклатуры производителя.
 ==Данные запроса==
-<!--<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Структура данных запроса в формате ХML.
-<div class = "mw-collapsible-content">
-<syntaxhighlight lang="xml">
-<ws:getProductItemByGuidRequest>
-         <base:guid>{base:guid}</base:guid>
-      </ws:getProductItemByGuidRequest>
-</syntaxhighlight>
-</div>
-</div>
--->
 ===Объект getProductItemByGuidRequest===
@@ Строка 40: / Строка 34: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''GUID''' || Глобальный идентификатор наименования номенклатуры производителя || [[UUID|bs:UUID]] || 1
+| '''GUID''' || Глобальный идентификатор наименования номенклатуры производителя. || [[UUID|bs:UUID]] || 1
 |}
 ==Данные ответа==
-<!--- div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Структура данных ответа в формате ХML.
-<div class = "mw-collapsible-content">
-<syntaxhighlight lang="xml">
-<ws:getProductByGuidResponse 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> -->
 ===Объект getProductItemByGuidResponse===
@@ Строка 76: / Строка 47: @@
 ! Поле !! Описание !! Тип !! Обязательность
 |-
-| [[#Объект ..Response/productItem|'''productItem''']] || Сущность, описывающая номенклатуру производителя || [[ProductItem|prod:ProductItem]] || 0..1
+| [[#Объект ..Response/productItem|'''productItem''']] || Сущность, описывающая номенклатуру производителя. || [[ProductItem|prod:ProductItem]] || 0..1
 |}
@@ Строка 82: / Строка 53: @@
 Объект содержит данные о единице номенклатуры продукции.
+{{Ветис.API ProductService ProductItem}}
+==Описание ошибок==
 {| 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
-|-
-| '''subProductGuid''' || Вид продукции (третий уровень иерархии справочника продукции) || [[UUID|bs:UUID]] || 1
 |}
@@ Строка 119: / Строка 77: @@
                    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:getProductItemByGuidRequest>
+    <ws:getProductItemByGuidRequest>
-         <base:guid>guid</base:guid>
+       <base:guid>6585132b-725a-4838-9571-7a8d10d361e2</base:guid>
-       </ws:getProductItemByGuidRequest>
+    </ws:getProductItemByGuidRequest>
-   </soapenv:Body>
+  </soapenv:Body>
+</soapenv:Envelope>
+</syntaxhighlight>
+</div>
+</div>
+<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:getProductItemByGuidResponse 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:productItem>
+        <bs:uuid>e1cf5ff6-6da6-4ddf-984b-a22a1ce37a7d</bs:uuid>
+        <bs:guid>6585132b-725a-4838-9571-7a8d10d361e2</bs:guid>
+        <bs:active>true</bs:active>
+        <bs:last>true</bs:last>
+        <bs:status>100</bs:status>
+        <bs:createDate>2016-11-16T13:50:08+03:00</bs:createDate>
+        <bs:updateDate>2016-11-16T13:50:08+03:00</bs:updateDate>
+        <pro:name>Пельмени холостяцкие условно-съедобные</pro:name>
+        <pro:productType>5</pro:productType>
+        <pro:product>
+          <bs:uuid>26b81265-a498-0a42-5b77-08da2eb03ab9</bs:uuid>
+          <bs:guid>b45f20b3-9ade-342e-976f-f1f3b2567c53</bs:guid>
+        </pro:product>
+        <pro:subProduct>
+          <bs:uuid>92302080-0972-9504-94c9-6b0028ccbdb6</bs:uuid>
+          <bs:guid>80b7fc16-110c-a663-67e3-b5d9ce3f02ff</bs:guid>
+        </pro:subProduct>
+        <pro:correspondToGost>false</pro:correspondToGost>
+        <pro:gost>ГОСТ_Р_51184-98</pro:gost>
+       </pro:productItem>
+    </ws:getProductItemByGuidResponse>
+  </S:Body>
 </soapenv:Envelope>
 </syntaxhighlight>
 </div>
 </div>