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

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


Операция '''GetProductItemByGuid''' предназначена для получения последней актуальной (last = true, active = true) записи о номенклатуре производителя по её глобальному идентификатору. Глобальный идентификатор присваивается номенклатуре при занесении её в список с помощью метода [[ModifyProducerStockListOperation|ModifyProducerStockListOperation]]. Выполнение операции заканчивается либо возвратом объекта номенклатуры производителя , либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Операция '''GetProductItemByGuid''' предназначена для получения последней актуальной (last = true, active = true) записи о номенклатуре производителя (4 уровень иерархического справочника) по её глобальному идентификатору. Глобальный идентификатор присваивается номенклатуре при занесении её в список с помощью метода [[ModifyProducerStockListOperation_v2.0|ModifyProducerStockListOperation]]. Выполнение операции заканчивается либо возвратом объекта номенклатуры производителя , либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 
<!--===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
{{столбцы}}
{{столбцы}}
{{столбец}}
{{столбец}}
Строка 16: Строка 15:
* [[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]]
{{столбцы/конец}}
{{столбцы/конец}}-->


===[[#Объект getProductItemByGuidRequest|Входные данные]]===
===Входные данные===
* глобальный уникальный идентификатор номенклатуры производителя.
* глобальный уникальный идентификатор номенклатуры производителя.


===[[#Объект getProductItemByGuidResponse|Выходные данные]]===
===Выходные данные===
* занесённые данные номенклатуры производителя.
* данные номенклатуры производителя.
 
==Данные запроса==
 
===Объект getProductItemByGuidRequest===
 
Корневой элемент запроса.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''GUID''' || Глобальный идентификатор наименования номенклатуры производителя. || [[UUID|bs:UUID]] || 1
|}
 
==Данные ответа==


===Объект getProductItemByGuidResponse===
==Спецификация запроса==


Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
==Спецификация ответа==
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/productItem|'''productItem''']] || Сущность, описывающая номенклатуру производителя. || [[ProductItem|prod:ProductItem]] || 0..1
|}
 
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/'''productItem'''===
 
{{Ветис.API ProductService ProductItem}}
 
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/[[#Объект ..Response/productItem|productItem]]/'''product'''===
 
Объект содержит информацию о продукции. Возвращаются только идентификаторы.
 
{| class="wikitable"
|-
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
| '''UUID''' || Идентификатор версии записи о продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/[[#Объект ..Response/productItem|productItem]]/'''subProduct'''===
 
Объект содержит информацию о продукции. Возвращаются только идентификаторы.
 
{| class="wikitable"
|-
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
| '''UUID''' || Идентификатор версии записи о виде продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}


==Описание ошибок==
==Описание ошибок==
Строка 98: Строка 45:
<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/"
 
                  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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 116: Строка 54:
<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/">
 
  <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>
</syntaxhighlight>
</div>
</div>

Версия 22:27, 29 октября 2017

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

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

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

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

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

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

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

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

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

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
EntityNotFoundFault Объект с заданными параметрами не найден в базе.

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

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


Ответ на запрос.

Источник — http://help.vetrf.ru/index.php?title=GetProductItemByGuid_v2.0&oldid=22216