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

Версия 12:24, 20 октября 2016

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

Метод возвращает список изменённых назначений груза за период времени.

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

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
status	Статус версии записи	xs:string	1
createDate	Дата создания записи о продукции в реестре РСХН	xs:dateTime	1
updateDate	Дата последнего обновления записи в реестре РСХН	xs:dateTime	1
previous	Идентификатор предыдущей версии записи	bs:UUID	1
next	Идентификатор следующей версии записи	bs:UUID	0..1
name	Название цели	xs:string	1
forSubstandard	Назначение для некачественных грузов	xs:boolean	0..1

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

Запрос данных о назначении "Для личного потребления"

<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:getPurposeByGuidRequest>
         <base:guid>5b91af60-e089-11e1-bcf3-b499babae7ea</base:guid>
      </ws:getPurposeByGuidRequest>
   </soapenv:Body>
</soapenv:Envelope>

@@ Строка 69: / Строка 69: @@
 ==Данные ответа==
-===Объект getPurposeByGuidResponse===
+===Объект getPurposeChangesListResponse===
-Корневой элемент ответа. Содержит информацию о цели назначения груза.
+Корневой элемент ответа. Содержит информацию о списке изменённых целей.
 {| class="wikitable"
@@ Строка 77: / Строка 77: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/purpose|'''purpose''']] || Сущность, описывающая назначение груза || [[Purpose|argc:Purpose]] || 1
+| [[#Объект ..Response/purposeList|'''purposeList''']] || Сущность, описывающая список назначений груза || [[PurposeList|argc:PurposeList]] || 1
 |}
+===Объект [[#Объект getPurposeByGuidResponse|..Response]]/'''purposeList'''===
-===Объект [[#Объект getPurposeByGuidResponse|..Response]]/'''purpose'''===
+Содержит в себе объекты, описывающие назначение перемещения груза.
+{| class="wikitable"
+|-
+! Поле !! Описание !! Тип данных !! Обязательность
+|-
+| [[#Объект ..Response/purposeList/purpose|'''purpose''']] || Сущность, описывающая назначение груза || [[Purpose|argc:Purpose]] || 1
+|}
+===Объект [[#Объект getPurposeByGuidResponse|..Response]]/[[#Объект ..Response/purposeList|purposeList]]/'''purpose'''===
 Объект содержит данные о назначении груза.
@@ Строка 99: / Строка 110: @@
 | '''createDate''' || Дата создания записи о продукции в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
 |-
-| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
+| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
 |-
-| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
+| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 1
 |-
 | '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1