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

Версия 10:24, 21 октября 2016

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

Метод возвращает список единиц измерения, в которые были внесены изменения в указанный период.

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

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

argc (http://api.vetrf.ru/schema/cdm/argus/common)
- argc:Unit
- argc:UnitList

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

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

Объект getUnitChangesListRequest

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

Поле	Описание	Тип данных	Обязательность
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

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

Объект getUnitChangesListResponse

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

Поле	Описание	Тип данных	Обязательность
unitList	Сущность, описывающая список единиц измерения	argc:UnitList	1

Объект ..Response/unitList

Объект содержит множество сущностей, описывающих единицу измерения.

Поле	Описание	Тип данных	Обязательность
unit	Сущность, описывающая единицу измерения	argc:Unit	1

Объект ..Response/unitList/unit

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

Поле	Описание	Тип	Обязательность
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	0..1
next	Идентификатор следующей версии записи	bs:UUID	0..1
name	Краткое название единицы измерения	xs:string	1
fullName	Полное название единицы измерения	xs:string	1
commonUnitGuid	Глобальный идентификатор базовой единицы измерения. Например, для центнера, тонны, тыс.тонн базовой единицей измерения является килограмм	bs:UUID	1
factor	Коэффициент относительно базовой единицы измерения. Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.	xs:integer	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:getUnitByUuidRequest>
         <base:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</base:uuid>
      </ws:getUnitByUuidRequest>
   </soapenv:Body>
</soapenv:Envelope>

@@ Строка 77: / Строка 77: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Response/unit|'''unit''']] || Сущность, описывающая единицу измерения || [[Unit|argc:Unit]] || 1
+| [[#Объект ..Response/unitList|'''unitList''']] || Сущность, описывающая список единиц измерения || [[UnitList|argc:UnitList]] || 1
 |}
@@ Строка 87: / Строка 87: @@
 {| class="wikitable"
 |-
-! Поле !! Описание !! Тип !! Обязательность
+! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''UUID''' || Идентификатор версии записи о единице измерения в реестре РСХН || [[UUID|bs:UUID]] || 1
+| [[#Объект ..Response/unitList/unit|'''unit''']] || Сущность, описывающая единицу измерения || [[Unit|argc:Unit]] || 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]] || 0..1
-|-
-| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
-|-
-| '''name''' || Краткое название единицы измерения || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''fullName''' || Полное название единицы измерения || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
-|-
-| '''commonUnitGuid''' || Глобальный идентификатор базовой единицы измерения. Например, для центнера, тонны, тыс.тонн базовой единицей измерения является килограмм || [[UUID|bs:UUID]] || 1
-|-
-| '''factor''' || Коэффициент относительно базовой единицы измерения. Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.  || [https://www.w3.org/TR/xmlschema-2/#integer xs:integer] || 1
 |}
-===Объект [[#Объект getUnitByUuidResponse|..Response]]/'''unit'''===
+===Объект [[#Объект getUnitByUuidResponse|..Response]]/[[#Объект ..Response/unitList|unitList]]/'''unit'''===
 Объект содержит данные о назначении груза.