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

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


Метод позволяет получить историю изменений в списке наименований продукции для номенклатуры предприятия-производителя. В список попадают записи, дата изменения которых попадает во временной интервал, указанный в запросе
Операция '''GetProductItemChangesList''' предназначена для получения истории изменений в списке наименований продукции для номенклатуры предприятия-производителя. В список попадают записи, дата изменения которых попадает во временной интервал, указанный в запросе. Записи необязательно будут актуальными и последними.


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


==Данные запроса==
==Данные запроса==
Строка 41: Строка 49:
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за который выбираются изменения. || [[DateInterval|bs:DateInterval]] || 1
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за который выбираются изменения. || [[DateInterval|bs:DateInterval]] || 1
|-
|-
| '''enterpriseGuid''' || Идентификатор предприятия, на котором производится или хранится продукция || [[UUID|bs:UUID]] || 1
| '''enterpriseGuid''' || Идентификатор предприятия, на котором производится или хранится продукция. || [[UUID|bs:UUID]] || 1
|}
|}


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


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




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


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


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


Строка 142: Строка 166:


<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">
Строка 149: Строка 173:
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base"  
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base"  
                   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:getProductItemChangesListRequest>
    <ws:getProductItemChangesListRequest>
        <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>
        <base:updateDateInterval>
      <base:updateDateInterval>
            <base:beginDate>2016-07-18T00:00:00</base:beginDate>
        <base:beginDate>2016-01-01</base:beginDate>
            <base:endDate>2016-08-18T00:00:00</base:endDate>
        <base:endDate></base:endDate>
        </base:updateDateInterval>
      </base:updateDateInterval>
        <ent:enterpriseGuid>guid</ent:enterpriseGuid>
      <ent:enterpriseGuid>d30316d4-31c9-43b8-a91d-f72d4b5d35f3</ent:enterpriseGuid>
      </ws:getProductItemChangesListRequest>
    </ws:getProductItemChangesListRequest>
  </soapenv:Body>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</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: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>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>

Версия 15:34, 16 ноября 2016

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

Операция GetProductItemChangesList предназначена для получения истории изменений в списке наименований продукции для номенклатуры предприятия-производителя. В список попадают записи, дата изменения которых попадает во временной интервал, указанный в запросе. Записи необязательно будут актуальными и последними.

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

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

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

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

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

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

Объект getProductItemChangesListRequest

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

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

Объект ..Request/listOptions

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

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

Объект ..Request/updateDateInterval

Объект содержит данные об интервале дат, за которые происходили изменения.

Поле Описание Тип данных Обязательность
beginDate Начальная дата интервала xs:dateTime 1
endDate Конечная дата интервала
  • Если конечная дата не указана, то по умолчанию используется текущая дата
 xs:dateTime 0..1

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

Объект getProductItemListResponse

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

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


Объект ..Response/productItemList

Объект содержит данные о единице номенклатуры продукции.

Поле Описание Тип Обязательность
UUID Идентификатор версии записи о номенклатуре производителя в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор номенклатуры производителя в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активна ли запись. xs:boolean 1
status Статус версии записи. xs:string 1
createDate Дата создания записи о номенклатуре производителя в реестре Россельхознадзора. xs:date 1
updateDate Дата последнего обновления записи в реестре Россельхознадзора. xs:date 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
next Идентификатор следующей версии записи. bs:UUID 0..1
name Название номенклатуры производителя. xs:string 1
code Код ТН ВЭД номенклатуры производителя. xs:string 1
productType Тип продукции (первый уровень иерархии справочника продукции). prod:ProductType 0..1
product Продукция (второй уровень иерархии справочника продукции). prod:Product 0..1
subProduct Вид продукции (третий уровень иерархии справочника продукции). prod:SubProduct 0..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

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

Запрос списка номенклатуры производителя, изменённый за период времени 

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


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

<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>
Источник — http://help.vetrf.ru/index.php?title=GetProductItemChangesList&oldid=18465