GetSubProductChangesList

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

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

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

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

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

  • параметры запрашиваемого списка;
  • интервал дат, за которые нужно получить изменения.

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

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

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

Объект getSubProductChangesListRequest

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

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

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

Объект getSubProductChangesListResponse

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

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

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

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

Объект ..Response/subProductList

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

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

Объект ..Response/subProductList/subProduct

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

Поле Описание Тип Обязательность
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
englishName Английское название вида продукции. bs:String255 0..1
productGuid Идентификатор продукции (второй уровень иерархии справочника продукции). 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">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getSubProductChangesListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2016-01-01</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
    </ws:getSubProductChangesListRequest>
  </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:getSubProductChangesListResponse 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:subProductList count="3" total="57" offset="0">
        <pro:subProduct>
          <bs:uuid>180e80cb-96bc-b51a-e03e-5eb90d29cbde</bs:uuid>
          <bs:guid>20824271-2c13-e259-8525-48bf8aaa97ef</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-09-08T17:55:09+03:00</bs:createDate>
          <bs:updateDate>2016-09-08T17:55:09+03:00</bs:updateDate>
          <pro:name>барда кормовая</pro:name>
          <pro:code>2303</pro:code>
          <pro:productGuid>cbd7826f-5470-1425-544f-3064651514ae</pro:productGuid>
          </pro:subProduct>
        <pro:subProduct>
          <bs:uuid>d17a6541-583e-5c65-4c96-cf047e6ac6d4</bs:uuid>
          <bs:guid>31849753-bbe2-61b3-5b71-23426e5d7342</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-09-08T17:55:09+03:00</bs:createDate>
          <bs:updateDate>2016-09-08T17:55:09+03:00</bs:updateDate>
          <pro:name>вика</pro:name>
          <pro:code>1214</pro:code>
          <pro:productGuid>cbd7826f-5470-1425-544f-3064651514ae</pro:productGuid>
        </pro:subProduct>
        <pro:subProduct>
          <bs:uuid>0f2b9965-7c56-2751-6c42-16cdceb445c6</bs:uuid>
          <bs:guid>13bfab8b-deb8-0bc7-8328-3f8b956949a2</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-09-08T17:55:09+03:00</bs:createDate>
          <bs:updateDate>2016-09-08T17:55:09+03:00</bs:updateDate>
          <pro:name>капуста кормовая</pro:name>
          <pro:code>1214</pro:code>
          <pro:productGuid>cbd7826f-5470-1425-544f-3064651514ae</pro:productGuid>
        </pro:subProduct>
      </pro:subProductList>
    </ws:getSubProductChangesListResponse>
  </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetSubProductChangesList&oldid=18546