Просмотр кода страницы GetPurposeChangesList

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

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


===Используемые пространства имён и типы===
{{столбцы}}
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] <nowiki>(http://api.vetrf.ru/schema/cdm/base)</nowiki>
** [[UUID|bs:UUID]]
** [[ListOptions|bs:ListOptions]]
** [[DateInterval|bs:DateInterval]]
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/common|argc]] <nowiki>(http://api.vetrf.ru/schema/cdm/argus/common)</nowiki>
** [[Purpose|argc:Purpose]]
** [[PurposeList|argc:PurposeList]]
{{столбец}}
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] <nowiki>(http://www.w3.org/2001/XMLSchema)</nowiki>
** [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбцы/конец}}

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

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

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

===Объект getPurposeChangesListRequest===

Корневой объект запроса. В нём указаны параметры запрашиваемого списка и интервал дат, за который запрашиваются изменения.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка.  || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые требуется получить изменения. || [[DateInterval|bs:DateInterval]] || 1
|}

===Объект [[#Объект getPurposeChangesListRequest|..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
|-
|}

===Объект [[#Объект getPurposeChangesListRequest|..Request]]/'''updateDateInterval'''===

Объект содержит сведения об интервале времени, за который необходимо получить обновления.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''beginDate''' || Дата, начиная с которой пользователь получит историю изменений записей. || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''endDate''' || Конец временного интервала. 
* В случае, если компонента endDate не указана, то используется текущая дата.
|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|}

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

===Объект getPurposeChangesListResponse===

Корневой элемент ответа. Содержит информацию о списке изменённых целей.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/purposeList|'''purposeList''']] || Сущность, описывающая список назначений груза. || [[PurposeList|argc:PurposeList]] || 1
|}

===Объект [[#Объект getPurposeChangesListResponse|..Response]]/'''purposeList'''===

Содержит в себе объекты, описывающие назначение перемещения груза.

{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/purposeList/purpose|'''purpose''']] || Сущность, описывающая назначение груза. || [[Purpose|argc:Purpose]] || 1
|}

'''Атрибуты списка purposeList'''

{{Ветис.API EntityList Attributes}}

===Объект [[#Объект getPurposeChangesListResponse|..Response]]/[[#Объект ..Response/purposeList|purposeList]]/'''purpose'''===

Объект содержит данные о назначении груза.

{{Ветис.API Dictionary Purpose|1}}

==Описание ошибок==
{| class="wikitable"
|-
! Ошибка !! Описание
|-
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
| '''IncorrectRequestFault''' || Некорректный   запрос.   Происходит   в   случае,   если   запрос   не   соответствует   требованиям указанным в xsd.
|-
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
|}

==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос списка назначений груза, измененных за период с 01.01.2016 по текущий день.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getPurposeChangesListRequest>
      <base:listOptions>
        <base:count>100</base:count>
        <base:offset>0</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2016-01-01T00:00:00</base:beginDate>
      </base:updateDateInterval>
    </ws:getPurposeChangesListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getPurposeChangesListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                      xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 
                                      xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
      <com:purposeList count="1" total="1" offset="0">
        <com:purpose>
          <bs:uuid>4715480a-4f1f-291d-adea-c4063de4704c</bs:uuid>
          <bs:guid>b5734ab1-c5d2-bff3-c102-0b1c8b11a004</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2016-09-08T17:49:38+03:00</bs:createDate>
          <bs:updateDate>2016-09-08T17:49:38+03:00</bs:updateDate>
          <com:name>оформление справки о безопасности сырого молока</com:name>
        </com:purpose>
      </com:purposeList>
    </ws:getPurposeChangesListResponse>
  </S:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>

[[Category:Ветис.API]]
[[Category:DictionaryService]]
[[Category:Реестры]]