GetUnitList v2.0: различия между версиями

Версия 23:24, 10 октября 2020

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

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

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

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

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

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

Спецификация запроса

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getUnitListRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка.
003	······<bs:count>10</bs:count>	xs:nonNegativeInteger	[0..1]	Максимальное запрашиваемое количество объектов в списке. По умолчанию значение 100; Максимально возможное значение 1000.
004	······<bs:offset>2</bs:offset>	xs:nonNegativeInteger	[0..1]	Номер элемента, по которому осуществляется смещение первого элемента списка. По умолчанию значение 0.
005	···</bs:listOptions>
006	</ws:getUnitListRequest>

Спецификация ответа

#	Название XML-элемента	Тип	Обязат.	Описание	Пример
1	<ws:getUnitListResponse>
2	···<dt:unitList count="25" total="25" offset="0">	dt:UnitList	[1..1]	Список единиц измерения total - всего записей; offset - смещение относительно первого элемента; count - количество выводимых записей.
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]	Является ли запись активной: true - запись активна; false - запись не активна.	<bs:active>true</bs:active>
7	·········<bs:last>	xs:boolean	[1..1]	Является ли версия записи последней: true - да; false - нет.	<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]	Коэффициент относительно базовой единицы измерения Например, для тонны = 1000	<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>

@@ Строка 31: / Строка 31: @@
 ! Тип
 ! Обязат.
-! Описание
+! Описание (нажмите [...] для отображения дополнительного описания)
-! Пример
 |-
-|1
+|001
-|style="font-weight: bold; font-family: Courier;" |<ws:getUnitListRequest>
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getUnitListRequest>'''}}
 |
 |
-|
+| style="width:52em;"|
-|style="font-family: Courier;" |
 |-
-|2
+|002
-|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
 |[[ListOptions|bs:ListOptions]]
 |[0..1]
-|Параметры запрашиваемого списка.
+| style="width:52em;"| Параметры запрашиваемого списка.
-|style="font-family: Courier;" |
 |-
-|3
+|003
-|style="font-weight: bold; font-family: Courier;" |······<bs:count>
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
 |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
 |[0..1]
-|Максимальное запрашиваемое количество объектов в списке.
+|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
+<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке.
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
 * По умолчанию значение 100;
-* Максимально возможное значение 1000.
+* Максимально возможное значение 1000.</div>
-|style="font-family: Courier;" |<bs:count>10</bs:count>
+</div>
 |-
-|4
+|004
-|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
 |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
 |[0..1]
-|Номер элемента, по которому осуществляется смещение первого элемента списка.
+|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
-* По умолчанию значение 0.
+<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.
-|style="font-family: Courier;" |<bs:offset>2</bs:offset>
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* По умолчанию значение 0.</div>
+</div>
 |-
-|5
+|005
-|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
 |
 |
-|
+| style="width:52em;"|
-|style="font-family: Courier;" |
 |-
-|6
+|006
-|style="font-weight: bold; font-family: Courier;" |</ws:getUnitListRequest>
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getUnitListRequest>'''}}
-|
 |
 |
-|style="font-family: Courier;" |
+| style="width:52em;"|
 |-
 |}