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

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


===Объект [[#Объект getProductChangesListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/product===
===Объект [[#Объект getProductChangesListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/'''product'''===


Описание продукции.
Описание продукции.


{| class="wikitable"
{{Ветис.API ProductService Product}}
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи продукции || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный уникальный идентификатор продукции || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''last''' || Флаг, указывающий, последняя ли запись || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''status''' || Статус записи. Обозначает причину появления текущей версии записи. || [http://www.w3.org/TR/xmlschema-2/#integer xs:integer] || 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
|-
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Идентификатор соедующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название продукции || [[String255|bs:String255]] || 1
|-
| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || 1
|-
| '''productType''' || Тип продукции || [[ProductType|prod:ProductType]] || 1
|}


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

Версия 09:26, 15 ноября 2016

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

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

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

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

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

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

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

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

Объект getProductChangesListRequest

Поле Описание Тип данных Обязательность
listOptions Параметры запрашиваемого списка bs:ListOptions 0..1
updateDateInterval Интервал дат, за которые запрашивают изменения bs:DateInterval 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

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

Объект getProductChangesListResponse

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

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

Объект ..Response/productList

Список продукции, полученной в результате запроса.

Поле Описание Тип данных Обязательность
product Данные о продукции. prod:Product 0..*

Объект ..Response/productList/product

Описание продукции.

Поле Описание Тип Обязательность
UUID Идентификатор версии записи продукции в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор продукции в реестре Россельхознадзора. bs:UUID 1
active Флаг, указывающий на то, активна ли запись. xs:boolean 1
last Флаг, указывающий на то, является ли запись последней. xs:boolean 1
status Статус версии записи. xs:string 1
createDate Дата создания записи о продукции в реестре Росcельхознадзора. xs:dateTime 1
updateDate Дата последнего обновления записи в реестре Россельхознадзора. xs:dateTime 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
name Название продукции. xs:string 1
code Код ТН ВЭД продукции. xs:string 1
productType Тип продукции (первый уровень иерархии справочника продукции). prod:ProductType 1

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

Запрос данных изменений за период с 01.01.2013 по 01.10.2016

<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:getProductChangesListRequest>
         <base:listOptions>
            <base:count>100</base:count>
            <base:offset>0</base:offset>
         </base:listOptions>
         <base:updateDateInterval>
            <base:beginDate>2013-01-01T00:00:00</base:beginDate>
            <base:endDate>2016-10-01T00:00:00</base:endDate>
         </base:updateDateInterval>
      </ws:getProductChangesListRequest>
   </soapenv:Body>
</soapenv:Envelope>