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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 24: Строка 24:


==Данные запроса==
==Данные запроса==
<!--<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных запроса в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<ws:getProductByGuidRequest>
        <base:guid>{base:guid}</base:guid>
      </ws:getProductByGuidRequest>
</syntaxhighlight>
</div>
</div>
-->
===Объект getProductByGuidRequest===
Корневой элемент запроса.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''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> -->
===Объект getProductByGuidResponse===
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| [[#Объект ..Response/product|'''product''']] || Объект содержит данные о продукции. || [[Product|prod:Product]] || 1
|}
===Объект [[#Объект getProductByGuidResponse|..Response]]/'''product'''===
Объект соержит данные о продукции.
{{Ветис.API ProductService Product}}


==Описание ошибок==
==Описание ошибок==
Строка 107: Строка 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:getProductByGuidRequest>
      <base:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</base:guid>
    </ws:getProductByGuidRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 125: Строка 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: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>3008afa9-8a88-8586-5f75-08ce43189ac8</bs:uuid>
        <bs:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</bs:guid>
        <bs:active>true</bs:active>
        <bs:last>true</bs:last>
        <bs:status>100</bs:status>
        <bs:createDate>2011-05-23T10:35:08+03:00</bs:createDate>
        <bs:updateDate>2011-05-23T10:35:08+03:00</bs:updateDate>
        <pro:name>готовые мясные продукты</pro:name>
        <pro:code>0210, 1601, 1602</pro:code>
        <pro:productType>5</pro:productType>
      </pro:product>
    </ws:getProductByGuidResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

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

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

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

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

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

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

  • данные о запрашиваемой продукции.

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

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

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

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

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

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


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