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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetProductChangesList''' предназначена для получения списка изменённо…»)
 
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


{{столбцы}}
{{столбцы}}
Строка 23: Строка 22:
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
** [[String255|bs:String255]]
** [[String255|bs:String255]]
{{столбцы/конец}}
{{столбцы/конец}}-->


===[[#Объект getProductChangesListRequest|Входные данные]]===
===Входные данные===
* тип продукции, изменения в котором необходимо получить;
* параметры возвращаемого списка;
* параметры возвращаемого списка;
* интервал дат, за который необходимо получить изменения.
* интервал дат, за который необходимо получить изменения.


===[[#Объект getProductChangesListResponse|Выходные данные]]===
===Выходные данные===
* список продукции указанного типа, изменённый за заданный период.
* список продукции, изменённый за заданный период.
 
==Данные запроса==
 
===Объект getProductChangesListRequest===
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые запрашивают изменения. || [[DateInterval|bs:DateInterval]] || 1
|}
 
===Объект [[#Объект getProductChangesListRequest|..Request]]/'''listOptions'''===
 
Объект содержит параметры запрашиваемого списка продукции.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''count''' || Количество значений в списке.
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000.
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
|}
 
===Объект [[#Объект getProductChangesListRequest|..Request]]/'''updateDateInterval'''===
 
Объект содержит данные об интервале дат, за которые происходили изменения.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''beginDate''' || Начальная дата интервала. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''endDate''' || Конечная дата интервала.
* Если конечная дата не задана, то по умолчанию используется текущая дата.
|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|}
 
==Данные ответа==
 
===Объект getProductChangesListResponse===
 
Корневой элемент ответа.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/productList|'''productList''']] || Список продукции выбранного типа. || [[ProductList|prod:ProductList]] || 1
|}


===Объект [[#Объект getProductChangesListResponse |..Response]]/'''productList'''===
==Спецификация запроса==


Список продукции, полученной в результате запроса.
==Спецификация ответа==
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[GetProductChangesList#Объект ..Response/productList/product|'''product''']] || Данные о продукции. || [[Product|prod:Product]] || 0..*
|}
 
'''Атрибуты списка productList'''
{{Ветис.API EntityList Attributes}}
 
===Объект [[#Объект getProductChangesListResponse |..Response]]/[[#Объект ..Response/productList|productList]]/'''product'''===
 
Описание продукции.
 
{{Ветис.API ProductService Product|1}}


==Описание ошибок==
==Описание ошибок==
Строка 128: Строка 53:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 153: Строка 62:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 211: Строка 72:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<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>5</base:count>
        <base:offset>3</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2014-05-10T00:00:00</base:beginDate>
      </base:updateDateInterval>
    </ws:getProductChangesListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 235: Строка 81:
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<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="5" total="26" offset="3">
            <pro:product>
              <bs:uuid>bdb9c4a6-af35-9e34-c30f-329596675f4b</bs:uuid>
              <bs:guid>ab2a9460-38a5-438b-37f6-ede0b5cfba2e</bs:guid>
              <bs:active>false</bs:active>
              <bs:last>false</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2012-03-16T13:42:12+03:00</bs:createDate>
              <bs:updateDate>2014-10-17T14:19:41+03:00</bs:updateDate>
              <bs:next>44d915e0-995b-40eb-900a-e0f06a5327ea</bs:next>
              <pro:name>минтай сушеный спинка с перцем</pro:name>
              <pro:code>1604</pro:code>
              <pro:productType>7</pro:productType>
            </pro:product>
            <pro:product>
              <bs:uuid>518cb109-e660-458c-b9e9-18945f259c73</bs:uuid>
              <bs:guid>29065aac-27be-4c45-b7b5-782571b7d728</bs:guid>
              <bs:active>false</bs:active>
              <bs:last>false</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2013-05-08T14:26:32+03:00</bs:createDate>
              <bs:updateDate>2014-10-17T14:15:46+03:00</bs:updateDate>
              <bs:next>710f8d1d-e468-4f97-adba-558108ce26cc</bs:next>
              <pro:name>минтай солено-сушеный стружка</pro:name>
              <pro:code>1604</pro:code>
              <pro:productType>7</pro:productType>
            </pro:product>
            <pro:product>
              <bs:uuid>f39dac4c-8f6a-4e19-b17b-7c868546fa8e</bs:uuid>
              <bs:guid>14cf212f-1d94-43f4-9584-aaa169faa40d</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2014-05-15T13:48:54+03:00</bs:createDate>
              <bs:updateDate>2014-05-15T13:48:54+03:00</bs:updateDate>
              <pro:name>Даманы</pro:name>
              <pro:code>0106</pro:code>
              <pro:productType>3</pro:productType>
            </pro:product>
            <pro:product>
              <bs:uuid>04ab2ca3-2051-403d-9650-55946084dd0a</bs:uuid>
              <bs:guid>64f91817-7c6f-4e1e-a2fb-b3d51934ed79</bs:guid>
              <bs:active>false</bs:active>
              <bs:last>false</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2014-09-16T15:56:22+03:00</bs:createDate>
              <bs:updateDate>2014-10-17T14:16:26+03:00</bs:updateDate>
              <bs:next>7bdd3340-5c1a-4fdb-91c1-131d4de7b928</bs:next>
              <pro:name>копченая икра кефали</pro:name>
              <pro:code>1604</pro:code>
              <pro:productType>7</pro:productType>
            </pro:product>
            <pro:product>
              <bs:uuid>50c02b08-ed03-49c9-81a0-fcb72bba83ed</bs:uuid>
              <bs:guid>2e327835-1f39-487e-adb0-61dfe31cf836</bs:guid>
              <bs:active>false</bs:active>
              <bs:last>false</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2014-10-13T10:45:22+03:00</bs:createDate>
              <bs:updateDate>2014-10-17T14:19:23+03:00</bs:updateDate>
              <bs:next>f2e817a0-5c33-481c-9bd1-82c67d44280c</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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

Версия 22:25, 29 октября 2017

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

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

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

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

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

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

Спецификация запроса

Спецификация ответа

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

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

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

Запрос на получение данных о трех первых изменениях за период с 01.01.2013 по 01.10.2016, без смещения.


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


Запрос на получение данных о пяти первых изменениях за период с 10.05.2014 по текущую дату, со смещением равным трем.


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

Источник — http://help.vetrf.ru/index.php?title=GetProductChangesList_v2.0&oldid=22215