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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показаны 24 промежуточные версии 2 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 22: Строка 22:
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getProductItemListRequest|Входные данные]]===
* параметры выводимого списка;
* глобальный идентификатор предприятия;
* глобальный идентификатор вида продукции.
===[[#Объект getProductItemListResponse|Выходные данные]]===
* список, отфильтрованный по виду продукции, выпускаемой на указанном предприятии.


==Данные запроса==
==Данные запроса==
Строка 33: Строка 41:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''listOptions''' || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
|-
| '''subProductGuid''' || Вид продукции, для которого нужно получить номенклатуру || [[UUID|bs:UUID]] || 1
| '''subProductGuid''' || Глобальный идентификатор вида продукции, для которого нужно получить номенклатуру. || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''enterpriseGuid''' || Идентификатор предприятия, на котором производится или хранится продукция || [[UUID|bs:UUID]] || 1
| '''enterpriseGuid''' || Глобальный идентификатор предприятия, на котором производится или хранится продукция. || [[UUID|bs:UUID]] || 1
|}
|}


===Объект [[#Объект getProductItemListRequest|..Request]]/listOptions===
===Объект [[#Объект getProductItemListRequest|..Request]]/'''listOptions'''===


Объект содержит параметры запрашиваемого списка продукции.
Объект содержит параметры запрашиваемого списка продукции.
Строка 48: Строка 56:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''count''' || Количество значений в списке
| '''count''' || Количество значений в возвращаемом списке.
* По умолчанию значение равно 100;
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000  
* Максимально допустимое значение равно 1000.
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|| [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
| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|}
|}


Строка 66: Строка 74:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Response/productItemList|'''productItemList''']] || Список продукции || [[ProductItemList|prod:ProductItemList]] || 1
| [[#Объект ..Response/productItemList|'''productItemList''']] || Список продукции. || [[ProductItemList|prod:ProductItemList]] || 1
|}
|}


===Объект [[#Объект getProductItemListResponse|..Response]]/'''productItemList'''===
===Объект [[#Объект getProductItemListResponse|..Response]]/'''productItemList'''===
Строка 78: Строка 85:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Response/productItemList/productItem|'''productItem''']] || Сущность, описывающая единицу номенклатуры. || [[ProductItem|prod:ProductItem]] || 1
| [[#Объект ..Response/productItemList/productItem|'''productItem''']] || Сущность, описывающая единицу номенклатуры. || [[ProductItem|prod:ProductItem]] || 0..1
|}
|}
'''Атрибуты списка productItemList'''
{{Ветис.API EntityList Attributes}}


===Объект [[#Объект getProductItemListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/'''productItem'''===
===Объект [[#Объект getProductItemListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/'''productItem'''===


Объект описывает сущность единицы номенклатуры.
{{Ветис.API ProductService ProductItem}}
 
===Объект [[#Объект getProductItemListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/[[#Объект ..Response/productItemList/productItem|productItem]]/'''product'''===
 
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.


{| class="wikitable"
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
|-
| '''UUID''' || Уникальный идентификатор версии записи || [[UUID|bs:UUID]] || 1
| '''UUID''' || Уникальный идентификатор версии записи о продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|-
| '''GUID''' || Глобальный идентификатор записи в реестре РСХН || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный идентификатор продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getProductItemListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/[[#Объект ..Response/productItemList/productItem|productItem]]/'''subProduct'''===
 
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.
 
{| class="wikitable"
|-
|-
| '''active''' || Флаг, указывающий, что запись активна || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
|-
| '''last''' || Флаг, указывающий, последняя ли версия записи || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
| '''UUID''' || Уникальный идентификатор версии записи о виде продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|-
| '''status''' || Статус записи, обозначает действие, приведшее к созданию записи || [[String255|bs:String255]] || 1
| '''GUID''' || Глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
|}
| '''createDate''' || Дата создания записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
 
|-
==Описание ошибок==
| '''updateDate''' || Дата обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
{| class="wikitable"
|-
| '''previous''' || Ссылка на предыдущую версию записи || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Ссылка на следующую версию записи || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название продукции || [[String255|bs:String255]] || 1
|-
| '''productType''' || Тип продукции, к которой относится номенклатура || [[ProductType|prod:ProductType]] || 1
|-
|-
| '''product''' || Продукция || [[Product|prod:Product]] || 1
! Ошибка !! Описание
|-
|-
| '''subProduct''' || Вид продукции || [[SubProduct|prod:SubProduct]] || 1
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
|-
| '''correspondToGost''' || Соответствует ли продукция ГОСТу || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 0..1
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.  
|-
|-
| '''gost''' || ГОСТ || [[String255|bs:String255]] || 0..1
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
|}
|}


Строка 123: Строка 137:


<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос списка номенклатуры производителя
Запрос на получение первой записи списка наименований продукции без смещения.
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Строка 131: Строка 145:
                   xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production"  
                   xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production"  
                   xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
                   xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
  <soapenv:Header/>
  <soapenv:Header/>
  <soapenv:Body>
  <soapenv:Body>
      <ws:getProductItemListRequest>
    <ws:getProductItemListRequest>
        <base:listOptions>
      <base:listOptions>
            <base:count>1000</base:count>
        <base:count>1</base:count>
            <base:offset>0</base:offset>
        <base:offset>0</base:offset>
        </base:listOptions>
      </base:listOptions>
        <prod:subProductGuid>0acb8bc2-b461-11ae-eb8a-9322c72dc5e2</prod:subProductGuid>
      <prod:subProductGuid>80b7fc16-110c-a663-67e3-b5d9ce3f02ff</prod:subProductGuid>
        <ent:enterpriseGuid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</ent:enterpriseGuid>
      <ent:enterpriseGuid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</ent:enterpriseGuid>
      </ws:getProductItemListRequest>
    </ws:getProductItemListRequest>
  </soapenv:Body>
  </soapenv:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>
<br />
<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: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>
</div>
</div>
[[Category:Ветис.API]]
[[Category:ProductService]]
[[Category:Реестры]]

Текущая версия на 13:59, 2 марта 2017

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

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

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

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

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

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

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

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

Объект getProductItemListRequest

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

Поле Описание Тип данных Обязательность
listOptions Параметры запрашиваемого списка. bs:ListOptions 0..1
subProductGuid Глобальный идентификатор вида продукции, для которого нужно получить номенклатуру. bs:UUID 0..1
enterpriseGuid Глобальный идентификатор предприятия, на котором производится или хранится продукция. bs:UUID 1

Объект ..Request/listOptions

Объект содержит параметры запрашиваемого списка продукции.

Поле Описание Тип данных Обязательность
count Количество значений в возвращаемом списке.
  • По умолчанию значение равно 100;
  • Максимально допустимое значение равно 1000.
xs:nonNegativeInteger 0..1
offset Смещение в списке относительно начала. xs:nonNegativeInteger 0..1

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

Объект getProductItemListResponse

Корневой объект, описывающий получаемый результат.

Поле Описание Тип данных Обязательность
productItemList Список продукции. prod:ProductItemList 1

Объект ..Response/productItemList

Объект, описывающий единицу номенклатуры производителя.

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

Атрибуты списка productItemList

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

Объект ..Response/productItemList/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

Объект ..Response/productItemList/productItem/product

Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.

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

Объект ..Response/productItemList/productItem/subProduct

Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.

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

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

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

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

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

<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>


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

<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>