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

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


===Объект getProductByTypeListResponse===
===Объект getSubProductByTypeListResponse===


Корневой элемент ответа.
Корневой элемент ответа.
Строка 77: Строка 77:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Request/productList|'''productList''']] || Список продукции выбранного типа || [[ProductList|prod:ProductList]] || 1
| [[#Объект ..Request/subProductList|'''subProductList''']] || Список продукции выбранного типа || [[SubProductList|prod:SubProductList]] || 1
|}
|}


===Объект [[#Объект getProductByTypeListResponse |..Response]]/productList===
===Объект [[#Объект getSubProductByTypeListResponse |..Response]]/subProductList===


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


{| class="wikitable"
{| class="wikitable"
Строка 88: Строка 88:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''product''' || Данные о продукции || [[Product|prod:Product]] || 0..*
| '''subProduct''' || Данные о продукции || [[Product|prod:Product]] || 0..*
|}
|}


Строка 99: Строка 99:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''UUID''' || Уникальный идентификатор версии записи продукции || [[UUID|bs:UUID]] || 1
| '''UUID''' || Уникальный идентификатор версии записи вида продукции || [[UUID|bs:UUID]] || 1
|-
|-
| '''GUID''' || Глобальный уникальный идентификатор продукции || [[UUID|bs:UUID]] || 1
| '''GUID''' || Глобальный уникальный идентификатор вида продукции || [[UUID|bs:UUID]] || 1
|-
|-
| '''active''' || Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
| '''active''' || Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
Строка 115: Строка 115:
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''next''' || Идентификатор соедующей версии записи || [[UUID|bs:UUID]] || 0..1
| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
|-
| '''name''' || Название продукции || [[String255|bs:String255]] || 1
| '''name''' || Название продукции || [[String255|bs:String255]] || 1
Строка 121: Строка 121:
| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || 1
| '''code''' || Код ТН ВЭД продукции || [[String255|bs:String255]] || 1
|-
|-
| '''productType''' || Тип продукции || [[ProductType|prod:ProductType]] || 1
| '''productGuid''' || Идентификатор продукции || [[UUID|bs:UUID]] || 1
|}
|}



Версия 14:57, 8 июля 2016

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

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

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

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

Объект geSubtProductChangesListRequest

Поле Описание Тип данных Обязательность
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 1

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

Объект getSubProductByTypeListResponse

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

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

Объект ..Response/subProductList

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

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

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

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

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи вида продукции bs:UUID 1
GUID Глобальный уникальный идентификатор вида продукции bs:UUID 1
active Флаг, обозначающий активна ли запись, то есть является ли последней версией, описывающей объект xs:boolean 1
last Флаг, указывающий, последняя ли запись xs:boolean 1
status Статус записи. Обозначает причину появления текущей версии записи. xs:integer 1
createDate Дата создания записи xs:dateTime 1
updateDate Дата обновления записи xs:dateTime 0..1
previous Идентификатор предыдущей версии записи bs:UUID 0..1
next Идентификатор следующей версии записи bs:UUID 0..1
name Название продукции bs:String255 1
code Код ТН ВЭД продукции bs:String255 1
productGuid Идентификатор продукции 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:prod="http://api.vetrf.ru/schema/cdm/argus/production">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getProductByTypeListRequest>
         <base:listOptions>
           <base:count>10</base:count>
           <base:offset>0</base:offset>
         </base:listOptions> 
         <prod:productType>5</prod:productType>
      </ws:getProductByTypeListRequest>
   </soapenv:Body>
</soapenv:Envelope>