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

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


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


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


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


===[[#Объект getSubProductChangesListResponse|Выходные данные]]===
===Выходные данные===
* список видов продукции, изменённых за указанный период времени.
* список видов продукции, изменённых за указанный период времени.


==Данные запроса==
==Спецификация запроса==
 
===Объект getSubProductChangesListRequest===
 
Корневой элемент запроса.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые запрашивают изменения. || [[DateInterval|bs:DateInterval]] || 1
|}
 
===Объект [[#Объект getSubProductChangesListRequest|..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
|-
|}
 
===Объект [[#Объект getSubProductChangesListRequest|..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
|}
 
==Данные ответа==
 
===Объект getSubProductChangesListResponse===
 
Корневой элемент ответа.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/subProductList|'''subProductList''']] || Список продукции выбранного типа. || [[SubProductList|prod:SubProductList]] || 1
|}
 
'''Атрибуты списка subProductList'''
 
{{Ветис.API EntityList Attributes}}
 
===Объект [[#Объект getSubProductChangesListResponse |..Response]]/'''subProductList'''===
 
Список видов продукции, полученной в результате запроса.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''[[#Объект ..Response/subProductList/subProduct|subProduct]]''' || Данные о продукции. || [[SubProduct|prod:SubProduct]] || 0..*
|}
 
===Объект [[#Объект getSubProductChangesListResponse |..Response]]/[[#Объект ..Response/subProductList|subProductList]]/'''subProduct'''===


Описание вида продукции.
==Спецификация ответа==
 
{{Ветис.API ProductService Subproduct|1}}


==Описание ошибок==
==Описание ошибок==
Строка 130: Строка 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: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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 155: Строка 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: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>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
Строка 210: Строка 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:getSubProductChangesListRequest>
      <base:listOptions>
        <base:count>5</base:count>
        <base:offset>3</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2015-02-21</base:beginDate>
        <base:endDate>2015-10-06</base:endDate>
      </base:updateDateInterval>
    </ws:getSubProductChangesListRequest>
  </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: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="5" total="92" offset="3">
            <pro:subProduct>
              <bs:uuid>55990442-66a7-4146-9f7f-f3d4ce0d0727</bs:uuid>
              <bs:guid>90720b98-0605-4453-b006-ae30acdec1b4</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2015-03-02T17:11:14+03:00</bs:createDate>
              <bs:updateDate>2015-03-02T17:11:14+03:00</bs:updateDate>
              <pro:name>инкубационное яйцо кур СПФ</pro:name>
              <pro:code>0407</pro:code>
              <pro:productGuid>6037d907-19c7-b1f1-37be-712f9f4bf5ed</pro:productGuid>
            </pro:subProduct>
            <pro:subProduct>
              <bs:uuid>f2cfd513-fd43-4c6d-b2eb-230cf024d127</bs:uuid>
              <bs:guid>633ae86b-0602-4e16-9fd5-0b22d3dc8a8e</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2015-03-10T10:28:13+03:00</bs:createDate>
              <bs:updateDate>2015-03-10T10:28:13+03:00</bs:updateDate>
              <pro:name>салака соленая пряного посола</pro:name>
              <pro:code>1604</pro:code>
              <pro:productGuid>46fde18a-f6af-f7b0-de47-044281271112</pro:productGuid>
            </pro:subProduct>
            <pro:subProduct>
              <bs:uuid>b86ea789-12bd-43be-a814-a56dc82627f1</bs:uuid>
              <bs:guid>37d4e7c8-3823-41a2-b32e-1beed138222e</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2015-03-11T09:10:13+03:00</bs:createDate>
              <bs:updateDate>2015-03-11T09:10:13+03:00</bs:updateDate>
              <pro:name>фарш кальмаровый варено-мороженый</pro:name>
              <pro:code>1605</pro:code>
              <pro:productGuid>f47dfeee-1673-22fe-9fb6-fa84247a9ebd</pro:productGuid>
            </pro:subProduct>
            <pro:subProduct>
              <bs:uuid>3baa715c-da87-4cf5-ad74-4fe142ff85dd</bs:uuid>
              <bs:guid>2dbdc467-eb84-4c90-9b90-a4f7fef91843</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2015-03-13T13:18:01+03:00</bs:createDate>
              <bs:updateDate>2015-03-13T13:18:01+03:00</bs:updateDate>
              <pro:name>мангуст карликовый</pro:name>
              <pro:code>0106</pro:code>
              <pro:productGuid>a9c0ff1b-9824-3045-16f5-a37d74c78e74</pro:productGuid>
            </pro:subProduct>
            <pro:subProduct>
              <bs:uuid>feb2b6b6-8c67-4f7b-832b-6ca3f6557957</bs:uuid>
              <bs:guid>6b3224b3-b977-4100-8205-f62a0c65fb7e</bs:guid>
              <bs:active>true</bs:active>
              <bs:last>true</bs:last>
              <bs:status>100</bs:status>
              <bs:createDate>2015-03-13T14:01:38+03:00</bs:createDate>
              <bs:updateDate>2015-03-13T14:01:38+03:00</bs:updateDate>
              <pro:name>пунчана</pro:name>
              <pro:code>0106</pro:code>
              <pro:productGuid>8b734283-b446-eb70-a8ba-1afbde1fcf5b</pro:productGuid>
            </pro:subProduct>
        </pro:subProductList>
      </ws:getSubProductChangesListResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>

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

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

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

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

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

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

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

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

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

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

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

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

Запрос списка первых трех изменённых видов продукции с 01.01.2016 по текущий день, без смещения.


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


Запрос списка первых пяти изменённых видов продукции с 21.02.2015 по 06.10.2015, со смещением равным трем.


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

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