GetProductChangesList

Материал из Справочная система Россельхознадзора
Версия от 15:50, 6 декабря 2016; Novikov-dv-160810 (обсуждение | вклад) (Исправлено описание примера запроса)
Перейти к навигации Перейти к поиску

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

Операция GetProductChangesList предназначена для получения списка изменённой продукции за указанный период времени. В результате запроса возвращается список всех версий продукции, последних и не последних (last=true, last=false), актуальных и не актуальных (active=true, active = false).

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

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

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

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

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

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

Объект 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..*

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

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

Объект ..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
next Идентификатор следующей версии записи. bs:UUID 0..1
name Название продукции. xs:string 1
code Код ТН ВЭД продукции. xs:string 1
productType Тип продукции (первый уровень иерархии справочника продукции). prod:ProductType 1

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

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

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

Запрос на получение данных о трех первых изменениях за период с 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>3</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>


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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <ws:getProductChangesListResponse 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:productList count="3" total="36" offset="0">
          <pro:product>
            <bs:uuid>f10930be-e0ab-ba27-b0dd-45f196897685</bs:uuid>
            <bs:guid>785350ed-900d-d57a-b0c3-6f91bfab99ac</bs:guid>
            <bs:active>false</bs:active>
            <bs:last>false</bs:last>
            <bs:status>100</bs:status>
            <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
            <bs:updateDate>2015-09-30T15:02:10+03:00</bs:updateDate>
            <bs:next>28d732d8-f25d-42e1-9a6f-aeacd75f3f34</bs:next>
            <pro:name>рыбы</pro:name>
            <pro:code>0106</pro:code>
            <pro:productType>3</pro:productType>
          </pro:product>
          <pro:product>
            <bs:uuid>adc13368-6ae2-0dba-b46c-2d4a2e90faf7</bs:uuid>
            <bs:guid>e50674d5-cc38-4543-f594-1621f26bd671</bs:guid>
            <bs:active>false</bs:active>
            <bs:last>false</bs:last>
            <bs:status>100</bs:status>
            <bs:createDate>2012-03-16T13:41:46+03:00</bs:createDate>
            <bs:updateDate>2014-10-17T14:20:18+03:00</bs:updateDate>
            <bs:next>9bfa8f21-d5ff-43d5-a427-5ffd709a89b4</bs:next>
            <pro:name>минтай сушеный спинка</pro:name>
            <pro:code>1604</pro:code>
            <pro:productType>7</pro:productType>
          </pro:product>
          <pro:product>
            <bs:uuid>61f70b47-2eef-4760-c08b-592cfe6304fd</bs:uuid>
            <bs:guid>8cdb6321-7d86-33a3-32d1-7a1c6a39320e</bs:guid>
            <bs:active>false</bs:active>
            <bs:last>false</bs:last>
            <bs:status>100</bs:status>
            <bs:createDate>2012-03-16T13:41:58+03:00</bs:createDate>
            <bs:updateDate>2014-10-17T14:18:43+03:00</bs:updateDate>
            <bs:next>2a6406b6-9a49-4751-aa7e-77718e58be57</bs:next>
            <pro:name>минтай сушеный с перцем шинкованный</pro:name>
            <pro:code>1604</pro:code>
            <pro:productType>7</pro:productType>
          </pro:product>
        </pro:productList>
      </ws:getProductChangesListResponse>
    </S:Body>
</soapenv:Envelope>
Источник — http://help.vetrf.ru/index.php?title=GetProductChangesList&oldid=18989