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

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


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


{{столбцы}}
{{столбцы}}
Строка 25: Строка 24:
** [[DateInterval|bs:DateInterval]]
** [[DateInterval|bs:DateInterval]]
** [[String255|bs:String255]]
** [[String255|bs:String255]]
{{столбцы/конец}}
{{столбцы/конец}}-->


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


===[[#Объект getProductItemChangesListResponse|Выходные данные]]===
===Выходные данные===
* список наименований продукции, изменённых за указанный период.
* список наименований продукции, изменённых за указанный период.


==Данные запроса==
==Спецификация запроса==
 
===Объект getProductItemChangesListRequest===
 
Корневой элемент запроса.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за который выбираются изменения. || [[DateInterval|bs:DateInterval]] || 1
|-
| '''enterpriseGuid''' || Идентификатор предприятия, на котором производится или хранится продукция. || [[UUID|bs:UUID]] || 1
|}


===Объект [[#Объект getProductItemChangesListRequest|..Request]]/'''listOptions'''===
==Спецификация ответа==


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


{| class="wikitable"
{| 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
|}
 
===Объект [[#Объект getProductItemChangesListRequest|..Request]]/'''updateDateInterval'''===
 
Объект содержит данные об интервале дат, за которые происходили изменения.
 
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип данных !! Обязательность
| '''InternalServiceFault'''  || Внутренняя ошибка сервиса.
|-
|-
| '''beginDate''' || Начальная дата интервала. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.  
|-
|-
| '''endDate''' || Конечная дата интервала.
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.  
* Если конечная дата не указана, то по умолчанию используется текущая дата.
|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|}
 
==Данные ответа==
 
===Объект getProductItemChangesListResponse===
 
Корневой объект, описывающий получаемый результат.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productItemList|'''productItemList''']] || Список продукции. || [[ProductItemList|prod:ProductItemList]] || 1
|}
 
'''Атрибуты списка productItemList'''
 
{{Ветис.API EntityList Attributes}}
 
===Объект [[#Объект getProductItemChangesListResponse|..Response]]/'''productItemList'''===
 
{{Ветис.API ProductService ProductItem|1}}
 
===Объект [[#Объект getProductItemChangesListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/[[#Объект ..Response/productItemList/productItem|productItem]]/'''product'''===
 
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.
 
{| class="wikitable"
|-
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
| '''UUID''' || Уникальный идентификатор версии записи о продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект getProductItemChangesListResponse|..Response]]/[[#Объект ..Response/productItemList|productItemList]]/[[#Объект ..Response/productItemList/productItem|productItem]]/'''subProduct'''===
 
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.
 
{| class="wikitable"
|-
! Поле !! Описание !! Текст заголовка !! Текст заголовка
|-
| '''UUID''' || Уникальный идентификатор версии записи о виде продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1
|}
|}


Строка 136: Строка 58:
<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:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getProductItemChangesListRequest>
      <base:listOptions>
        <base:count>1</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2016-01-01</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
      <ent:enterpriseGuid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</ent:enterpriseGuid>
    </ws:getProductItemChangesListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 166: Строка 70:
<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:getProductItemChangesListResponse 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:getProductItemChangesListResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

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

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

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

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

  • параметры выводимого списка;
  • интервал дат, за который запрашиваются изменения;
  • идентификатор предприятия, по номенклатуре которого запрашивается список изменений;
  • идентификатор хозяйствующего субъекта, по номенклатуре которого запрашивается список изменений.

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

  • список наименований продукции, изменённых за указанный период.

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

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

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

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

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

Запрос первой записи номенклатуры производителя, измененной с 01.01.2016 по текущий день, без смещения.


Пример ответа

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

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