GetUnitList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 248: | Строка 248: | ||
==Пример запроса== | ==Пример запроса== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Запрос первых | Запрос первых трёх единиц измерения без смещения. | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base"> | |||
<soapenv:Header/> | |||
<soapenv:Body> | |||
<ws:getUnitListRequest> | |||
<bs:listOptions> | |||
<bs:count>3</bs:count> | |||
<bs:offset>0</bs:offset> | |||
</bs:listOptions> | |||
</ws:getUnitListRequest> | |||
</soapenv:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
Строка 260: | Строка 270: | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> | |||
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> | |||
<v2:getUnitListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2"> | |||
<dt:unitList count="3" total="25" offset="0"> | |||
<dt: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> | |||
<dt:name>бочка</dt:name> | |||
<dt:fullName>бочка</dt:fullName> | |||
<dt:commonUnitGuid>52082c55-8628-409f-818c-80a02632c09f</dt:commonUnitGuid> | |||
<dt:factor>1</dt:factor> | |||
</dt:unit> | |||
<dt: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+04:00</bs:createDate> | |||
<bs:updateDate>2009-04-22T18:57:11+04:00</bs:updateDate> | |||
<dt:name>голова</dt:name> | |||
<dt:fullName>голова</dt:fullName> | |||
<dt:commonUnitGuid>4c7c19ff-a24c-49da-b4e9-d64a8dd6ce94</dt:commonUnitGuid> | |||
<dt:factor>1</dt:factor> | |||
</dt:unit> | |||
<dt: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> | |||
<dt:name>грамм</dt:name> | |||
<dt:fullName>грамм</dt:fullName> | |||
<dt:commonUnitGuid>2ed1cbda-22a4-4f3c-9865-dd47be2c655e</dt:commonUnitGuid> | |||
<dt:factor>1000</dt:factor> | |||
</dt:unit> | |||
</dt:unitList> | |||
</v2:getUnitListResponse> | |||
</soap:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> |
Версия 11:58, 30 октября 2017
Общие сведения
Операция GetUnitList предназначена для получения списка актуальных записей о единицах измерения (active=true, last=true). Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка единиц измерения, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка.
Выходные данные
- список актуальных единиц измерения.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getUnitListRequest> | ||||
2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<bs:offset>2</bs:offset> |
5 | ···</bs:listOptions> | ||||
6 | </ws:getUnitListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getUnitListResponse> | ||||
2 | ···<dt:unitList count="25" total="25" offset="0"> | dt:UnitList | [1..1] | Список единиц измерения
|
|
3 | ······<dt:unit> | dt:Unit | [0..*] | Единица измерения | |
4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии единицы измерения | <bs:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</bs:uuid> |
5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор единицы измерения | <bs:guid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</bs:guid> |
6 | ·········<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
7 | ·········<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
8 | ·········<bs:status> | bs:VersionStatus | [1..1] | Статус версии единицы измерения | <bs:status>100</bs:status> |
9 | ·········<bs:createDate> | xs:DateTime | [1..1] | Дата создания единицы измерения | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
10 | ·········<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения единицы измерения | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
11 | ·········<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи реестра единиц измерения | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи реестра единиц измерения | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
13 | ·········<dt:name> | bs:String255 | [1..1] | Наименование единицы измерения | <dt:name>кг</dt:name> |
14 | ·········<dt:fullName> | bs:String255 | [1..1] | Полное наименование единицы измерения | <dt:fullName>килограмм</dt:fullName> |
15 | ·········<dt:commonUnitGuid> | bs:UUID | [1..1] | Глобальный идентификатор базовой единицы измерения
|
<dt:commonUnitGuid>21ed96c9-337b-4a27-8761-c6e6ad3c9f5b</dt:commonUnitGuid> |
16 | ·········<dt:factor> | xs:integer | [1..1] | Коэффициент относительно базовой единицы измерения
|
<dt:factor>1</dt:factor> |
17 | ······</dt:unit> | ||||
18 | ···</dt:unitList> | ||||
19 | </ws:getUnitListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трёх единиц измерения без смещения.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base">
<soapenv:Header/>
<soapenv:Body>
<ws:getUnitListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
</ws:getUnitListRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<v2:getUnitListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
<dt:unitList count="3" total="25" offset="0">
<dt: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>
<dt:name>бочка</dt:name>
<dt:fullName>бочка</dt:fullName>
<dt:commonUnitGuid>52082c55-8628-409f-818c-80a02632c09f</dt:commonUnitGuid>
<dt:factor>1</dt:factor>
</dt:unit>
<dt: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+04:00</bs:createDate>
<bs:updateDate>2009-04-22T18:57:11+04:00</bs:updateDate>
<dt:name>голова</dt:name>
<dt:fullName>голова</dt:fullName>
<dt:commonUnitGuid>4c7c19ff-a24c-49da-b4e9-d64a8dd6ce94</dt:commonUnitGuid>
<dt:factor>1</dt:factor>
</dt:unit>
<dt: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>
<dt:name>грамм</dt:name>
<dt:fullName>грамм</dt:fullName>
<dt:commonUnitGuid>2ed1cbda-22a4-4f3c-9865-dd47be2c655e</dt:commonUnitGuid>
<dt:factor>1000</dt:factor>
</dt:unit>
</dt:unitList>
</v2:getUnitListResponse>
</soap:Body>
</soapenv:Envelope>