GetUnitList

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

Операция GetUnitList предназаначена для получения списка актуальных версий единиц измерения (active=true, last=true). Поддерживается постраничный вывод.

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

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

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

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

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

параметры выводимого списка.

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

список актуальных единиц измерения.

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

Объект getUnitListRequest

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

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры запрашиваемого списка.	bs:ListOptions	0..1

Объект ..Request/listOptions

Объект содержит в себе параметры запрашиваемого списка.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке По умолчанию значение равно 100; Максимально допустимое значение равно 1000.	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала.	xs:nonNegativeInteger	0..1

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

Объект getUnitListResponse

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

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

Объект ..Response/unitList

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

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

Атрибуты списка unitList

Атрибут	Описание	Тип данных	Обязательность
count	Количество элементов списка, запрашиваемое или переданное.	xs:int	1
total	Общий размер списка.	xs:long	1
offset	Смещение первого элемента списка относительно его начала.	xs:int	1

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

Объект содержит данные о единице измерения.

Поле	Описание	Тип	Обязательность
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	1
fullName	Полное название единицы измерения.	xs:string	1
commonUnitGuid	Глобальный идентификатор базовой единицы измерения. Например, для тонны базовой единицей измерения является килограмм.	bs:UUID	1
factor	Коэффициент относительно базовой единицы измерения. Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.	xs:integer	1

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

Запрос данных об изменении единиц измерения с 1 января 2010 года по текущую дату.

<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:getUnitListRequest>
        <base:listOptions>
           <base:count>100</base:count>
           <base:offset>0</base:offset>
         </base:listOptions>
      </ws:getUnitListRequest>
   </soapenv:Body>
</soapenv:Envelope>>