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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 23: Строка 23:
==Данные запроса==
==Данные запроса==


===Объект getUnitByUuidRequest===
===Объект getUnitChangesListRequest===


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


{| class="wikitable"
{| class="wikitable"
Строка 31: Строка 31:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''UUID''' || Глобальный идентификатор единицы измерения, по которому производится поиск записи  || [[UUID|bs:UUID]] || 1
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка  || [[ListOptions|bs:ListOptions]] || 0..1
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые требуется получить изменения || [[DateInterval|bs:DateInterval]] || 1
|}
 
===Объект [[#Объект getUnitChangesListRequest|..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
|-
|}
 
===Объект [[#Объект getUnitChangesListRequest|..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
|}
|}



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

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

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

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

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

Объект 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

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

Объект getUnitByUuidResponse

Корневой элемент ответа. Содержит информацию о цели назначения груза.

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


Объект ..Response/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>