Общие сведения
Операция GetUnitList предназначена для получения списка актуальных версий единиц измерения (active=true, last=true). Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка единиц измерения, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
- bs (http://api.vetrf.ru/schema/cdm/base)
|
- argc (http://api.vetrf.ru/schema/cdm/argus/common)
|
- xs (http://www.w3.org/2001/XMLSchema)
|
- параметры выводимого списка.
- список актуальных единиц измерения.
Данные запроса
Объект getUnitListRequest
Корневой объект запроса. В нём указаны параметры запрашиваемого списка.
Объект ..Request/listOptions
Объект содержит в себе параметры запрашиваемого списка.
| Поле |
Описание |
Тип данных |
Обязательность
|
| count |
Количество значений в списке.
- По умолчанию значение равно 100;
- Максимально допустимое значение равно 1000.
|
xs:nonNegativeInteger |
0..1
|
| offset |
Смещение в списке относительно начала. |
xs:nonNegativeInteger |
0..1
|
Данные ответа
Объект getUnitListResponse
Корневой элемент ответа. Содержит список изменённых единиц измерения.
| Поле |
Описание |
Тип данных |
Обязательность
|
| unitList |
Сущность, описывающая список единиц измерения. |
argc:UnitList |
1
|
Объект содержит множество сущностей, описывающих единицу измерения.
| Поле |
Описание |
Тип данных |
Обязательность
|
| unit |
Сущность, описывающая единицу измерения. |
argc:Unit |
1
|
Атрибуты списка unitList
| Атрибут |
Описание |
Тип данных |
Обязательность
|
| count |
Количество элементов списка, запрашиваемое или переданное. |
xs:int |
1
|
| total |
Общий размер списка. |
xs:long |
1
|
| offset |
Смещение первого элемента списка относительно его начала. |
xs:int |
1
|
Объект содержит данные о единице измерения.
| Поле |
Описание |
Тип |
Обязательность
|
| 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
|
Пример запроса
развернуть
Запрос первых десяти единиц измерения, без смещения.
<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>10</base:count>
<base:offset>0</base:offset>
</base:listOptions>
</ws:getUnitListRequest>
</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:getUnitListResponse 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:unitList count="10" total="25" offset="0">
<com:unit>
<bs:uuid>069796f6-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>52082c55-8628-409f-818c-80a02632c09f</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
<com:name>бочка</com:name>
<com:fullName>бочка</com:fullName>
<com:commonUnitGuid>52082c55-8628-409f-818c-80a02632c09f</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>06979926-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>4c7c19ff-a24c-49da-b4e9-d64a8dd6ce94</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2009-04-22T18:57:11+03:00</bs:createDate>
<bs:updateDate>2009-04-22T18:57:11+03:00</bs:updateDate>
<com:name>голова</com:name>
<com:fullName>голова</com:fullName>
<com:commonUnitGuid>4c7c19ff-a24c-49da-b4e9-d64a8dd6ce94</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>06979aca-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>db13bfe1-204f-4e28-a5ea-da51660b0469</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2009-12-22T15:48:57+03:00</bs:createDate>
<bs:updateDate>2009-12-22T15:48:57+03:00</bs:updateDate>
<com:name>грамм</com:name>
<com:fullName>грамм</com:fullName>
<com:commonUnitGuid>2ed1cbda-22a4-4f3c-9865-dd47be2c655e</com:commonUnitGuid>
<com:factor>1000</com:factor>
</com:unit>
<com:unit>
<bs:uuid>0697955c-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>149a87a8-e4af-47f9-a6cf-9d6d8138cc76</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
<com:name>доза</com:name>
<com:fullName>доза</com:fullName>
<com:commonUnitGuid>149a87a8-e4af-47f9-a6cf-9d6d8138cc76</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>0697a6b4-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>8a080965-fd21-4fb3-b635-efed9515ec34</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2010-11-24T15:28:56+03:00</bs:createDate>
<bs:updateDate>2010-11-24T15:28:56+03:00</bs:updateDate>
<com:name>канистра</com:name>
<com:fullName>канистра</com:fullName>
<com:commonUnitGuid>8a080965-fd21-4fb3-b635-efed9515ec34</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
<com:name>кг</com:name>
<com:fullName>кг</com:fullName>
<com:commonUnitGuid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>069795e8-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>4a55ffa0-b0a6-4ba5-a841-c0333fcd056b</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
<com:name>коробка</com:name>
<com:fullName>коробка</com:fullName>
<com:commonUnitGuid>4a55ffa0-b0a6-4ba5-a841-c0333fcd056b</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>0697a3da-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>194bb2dc-cf36-4d3a-bfc4-b2e80a9fd1be</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2009-12-02T11:36:34+03:00</bs:createDate>
<bs:updateDate>2009-12-02T11:36:34+03:00</bs:updateDate>
<com:name>литр</com:name>
<com:fullName>литр</com:fullName>
<com:commonUnitGuid>864afd62-35c2-4da7-94e3-85aaaf2243f0</com:commonUnitGuid>
<com:factor>1000</com:factor>
</com:unit>
<com:unit>
<bs:uuid>0697a470-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>2ed1cbda-22a4-4f3c-9865-dd47be2c655e</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2009-12-22T15:49:07+03:00</bs:createDate>
<bs:updateDate>2009-12-22T15:49:07+03:00</bs:updateDate>
<com:name>мг</com:name>
<com:fullName>миллиграмм</com:fullName>
<com:commonUnitGuid>2ed1cbda-22a4-4f3c-9865-dd47be2c655e</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
<com:unit>
<bs:uuid>0697980e-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>39154bdf-cb89-443f-af93-8345dd9042d0</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
<com:name>метр</com:name>
<com:fullName>метр</com:fullName>
<com:commonUnitGuid>39154bdf-cb89-443f-af93-8345dd9042d0</com:commonUnitGuid>
<com:factor>1</com:factor>
</com:unit>
</com:unitList>
</ws:getUnitListResponse>
</S:Body>
</soapenv:Envelope>
