GetPurposeChangesList: различия между версиями

Версия 11:34, 18 ноября 2016

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

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

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

bs (http://api.vetrf.ru/schema/cdm/base)

argc (http://api.vetrf.ru/schema/cdm/argus/common)
- argc:Purpose
- argc:PurposeList

xs (http://www.w3.org/2001/XMLSchema)

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

параметры выводимого списка;
интервал дат, за за который запрашиваются изменения.

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

список назначений груза за указанный период времени.

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

Объект getPurposeChangesListRequest

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

Поле	Описание	Тип данных	Обязательность
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	Конец временного интервала. В случае, если компонента endDate не указана, то используется текущая дата.	xs:dateTime	0..1

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

Объект getPurposeChangesListResponse

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

Поле	Описание	Тип данных	Обязательность
purposeList	Сущность, описывающая список назначений груза.	argc:PurposeList	1

Объект ..Response/purposeList

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

Поле	Описание	Тип данных	Обязательность
purpose	Сущность, описывающая назначение груза.	argc:Purpose	1

Объект ..Response/purposeList/purpose

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

Поле	Описание	Тип	Обязательность
UUID	Идентификатор версии записи о назначении груза в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор назначения груза в реестре Россельхознадзора.	bs:UUID	1
active	Флаг, указывающий на то, активна ли запись.	xs:boolean	1
last	Флаг, указывающий на то, является ли запись последней.	xs:boolean	1
status	Статус версии записи.	xs:string	1
createDate	Дата создания записи о назначении груза в реестре Россельхознадзора.	xs:dateTime	1
updateDate	Дата последнего обновления записи в реестре Россельхознадзора.	xs:dateTime	1
previous	Идентификатор предыдущей версии записи.	bs:UUID	0..1
name	Название цели (назначения груза).	xs:string	0..1

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

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

Запрос изменений с 1 января 2016 по текущую дату

<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>

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

<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>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Метод возвращает список изменённых назначений груза за период времени.
+Операция '''GetPurposeChangesList''' предназначена для получения списка изменённых назначений груза за период времени. В список попадают записи, дата изменения которых попадает в интервал, указанный в запросе. Записи в списке могут быть не последними и не актуальными (last=false, active=false).
 ===Используемые пространства имён и типы===
@@ Строка 20: / Строка 20: @@
 ** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
 {{столбцы/конец}}
+===[[#Объект getPurposeChangesListRequest|Входные данные]]===
+* параметры выводимого списка;
+* интервал дат, за за который запрашиваются изменения.
+===[[#Объект getPurposeChangesListResponse|Выходные данные]]===
+* список назначений груза за указанный период времени.
 ==Данные запроса==
@@ Строка 31: / Строка 38: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка  || [[ListOptions|bs:ListOptions]] || 0..1
+| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка.  || [[ListOptions|bs:ListOptions]] || 0..1
 |-
-| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые требуется получить изменения || [[DateInterval|bs:DateInterval]] || 1
+| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые требуется получить изменения. || [[DateInterval|bs:DateInterval]] || 1
 |}
-===Объект [[#Объект getPurposeChangesListRequest|..Request]]/listOptions===
+===Объект [[#Объект getPurposeChangesListRequest|..Request]]/'''listOptions'''===
 Объект содержит в себе параметры запрашиваемого списка.
@@ Строка 46: / Строка 53: @@
 | '''count''' || Количество значений в списке
 * По умолчанию значение равно 100;
-* Максимально допустимое значение равно 1000
+* Максимально допустимое значение равно 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
+| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
 |-
 |}
@@ Строка 77: / Строка 84: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/purposeList|'''purposeList''']] || Сущность, описывающая список назначений груза || [[PurposeList|argc:PurposeList]] || 1
+| [[#Объект ..Response/purposeList|'''purposeList''']] || Сущность, описывающая список назначений груза. || [[PurposeList|argc:PurposeList]] || 1
 |}
@@ Строка 88: / Строка 95: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/purposeList/purpose|'''purpose''']] || Сущность, описывающая назначение груза || [[Purpose|argc:Purpose]] || 1
+| [[#Объект ..Response/purposeList/purpose|'''purpose''']] || Сущность, описывающая назначение груза. || [[Purpose|argc:Purpose]] || 1
 |}
@@ Строка 95: / Строка 102: @@
 Объект содержит данные о назначении груза.
-{| class="wikitable"
+{{Ветис.API Dictionary Purpose}}
-|-
-! Поле !! Описание !! Тип !! Обязательность
-|-
-| '''UUID''' || Идентификатор версии записи о назначении груза в реестре РСХН || [[UUID|bs:UUID]] || 1
-|-
-| '''GUID''' || Глобальный идентификатор назначения груза в реестре РСХН || [[UUID|bs:UUID]] || 1
-|-
-| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
-|-
-| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''createDate''' || Дата создания записи о назначении груза в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
-|-
-| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
-|-
-| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 1
-|-
-| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
-|-
-| '''name''' || Название цели || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''forSubstandard''' || Назначение для некачественных грузов || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 0..1
-|-
-|}
+==Описание ошибок==
 ==Пример запроса==
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
@@ Строка 129: / Строка 113: @@
                    xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"
                    xmlns:base="http://api.vetrf.ru/schema/cdm/base">
-   <soapenv:Header/>
+  <soapenv:Header/>
-   <soapenv:Body>
+  <soapenv:Body>
-      <ws:getPurposeChangesListRequest>
+    <ws:getPurposeChangesListRequest>
-       <base:listOptions>
+      <base:listOptions>
-          <base:count>100</base:count>
+        <base:count>100</base:count>
-          <base:offset>0</base:offset>
+        <base:offset>0</base:offset>
-       </base:listOptions>
+      </base:listOptions>
-       <base:updateDateInterval>
+      <base:updateDateInterval>
-         <base:beginDate>2016-01-01T00:00:00</base:beginDate>
+        <base:beginDate>2016-01-01T00:00:00</base:beginDate>
        </base:updateDateInterval>
-     </ws:getPurposeChangesListRequest>
+    </ws:getPurposeChangesListRequest>
-   </soapenv:Body>
+  </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>