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

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


Операция '''GetProductItemList''' предназначена для получения списка наименований продукции отфильтрованных по указанному продукту по номенклатуре определенного предприятия-производителя. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Добавить записи номенклатуры производителя можно с помощью операции [[ModifyProducerStockListOperation]]. Выполнение операции заканчивается либо возвратом списка наименований продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Операция '''GetProductItemList''' предназначена для получения списка наименований продукции с возможностью фильтрации по уровням продукции иерархического справочника, по номенклатуре определенного предприятия-производителя или всех предприятий определенного хозяйствующего субъекта. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Добавить записи номенклатуры производителя можно с помощью операции [[ModifyProducerStockListOperation_v2.0|ModifyProducerStockListOperation]]. Выполнение операции заканчивается либо возвратом списка наименований продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
 
<!--===Используемые пространства имён и типы===
===Используемые пространства имён и типы===


{{столбцы}}
{{столбцы}}
Строка 21: Строка 20:
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
{{столбцы/конец}}
{{столбцы/конец}}-->


===[[#Объект getProductItemListRequest|Входные данные]]===
===Входные данные===
* параметры выводимого списка;
* параметры выводимого списка;
* глобальный идентификатор предприятия;
* идентификатор типа продукции (1 уровень иерархического справочника);
* глобальный идентификатор вида продукции.
* глобальный идентификатор продукции (2 уровень иерархического справочника).
 
* глобальный идентификатор вида продукции (3 уровень иерархического справочника).
===[[#Объект getProductItemListResponse|Выходные данные]]===
* глобальный идентификатор предприятия-производителя.
* список, отфильтрованный по виду продукции, выпускаемой на указанном предприятии.
* глобальный идентификатор хозяйствующего субъекта.
 
==Данные запроса==
 
===Объект getProductItemListRequest===
 
Корневой элемент запроса.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| '''subProductGuid''' || Глобальный идентификатор вида продукции, для которого нужно получить номенклатуру. || [[UUID|bs:UUID]] || 0..1
|-
| '''enterpriseGuid''' || Глобальный идентификатор предприятия, на котором производится или хранится продукция. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getProductItemListRequest|..Request]]/'''listOptions'''===
 
Объект содержит параметры запрашиваемого списка продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''count''' || Количество значений в возвращаемом списке.
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000.
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|}
 
==Данные ответа==
 
===Объект getProductItemListResponse===
 
Корневой объект, описывающий получаемый результат.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productItemList|'''productItemList''']] || Список продукции. || [[ProductItemList|prod:ProductItemList]] || 1
|}
 
===Объект [[#Объект getProductItemListResponse|..Response]]/'''productItemList'''===
 
Объект, описывающий единицу номенклатуры производителя.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productItemList/productItem|'''productItem''']] || Сущность, описывающая единицу номенклатуры. || [[ProductItem|prod:ProductItem]] || 0..1
|}
 
'''Атрибуты списка productItemList'''
 
{{Ветис.API EntityList Attributes}}


===Объект [[#Объект getProductItemListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/'''productItem'''===
===Выходные данные===
* список продукции (4 уровень иерархического справочника), отфильтрованный по заданным параметрам.


{{Ветис.API ProductService ProductItem}}
==Спецификация запроса==


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


==Описание ошибок==
==Описание ошибок==
Строка 140: Строка 55:
<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"
                  xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production"
                  xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getProductItemListRequest>
      <base:listOptions>
        <base:count>1</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <prod:subProductGuid>80b7fc16-110c-a663-67e3-b5d9ce3f02ff</prod:subProductGuid>
      <ent:enterpriseGuid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</ent:enterpriseGuid>
    </ws:getProductItemListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 165: Строка 64:
<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:getProductItemListResponse 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:productItemList count="1" total="3" offset="0">
        <pro:productItem>
          <bs:uuid>e25f9b37-9f4e-4eda-8fa4-1812c4b267aa</bs:uuid>
          <bs:guid>812807ee-59c4-4956-9bff-ecefd12f7bff</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-11-10T09:45:32+03:00</bs:createDate>
          <bs:updateDate>2016-11-10T09:45:32+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>
      </pro:productItemList>
    </ws:getProductItemListResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

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

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

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

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

  • параметры выводимого списка;
  • идентификатор типа продукции (1 уровень иерархического справочника);
  • глобальный идентификатор продукции (2 уровень иерархического справочника).
  • глобальный идентификатор вида продукции (3 уровень иерархического справочника).
  • глобальный идентификатор предприятия-производителя.
  • глобальный идентификатор хозяйствующего субъекта.

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

  • список продукции (4 уровень иерархического справочника), отфильтрованный по заданным параметрам.

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

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

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

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

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

Запрос на получение первой записи списка наименований продукции без смещения.


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

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