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

Версия 15:51, 27 сентября 2020

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

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

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

параметры выводимого списка;
тип продукции (1 уровень иерархического справочника).

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

список продукции (2 уровень иерархического справочника).

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getProductByTypeListRequest>
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	···<dt:productType>5</dt:productType>	dt:ProductType	[1..1]	Тип продукции. первый уровень иерархического справочника продукции ИС Меркурий
007	</ws:getProductByTypeListRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание	Пример
1	<ws:getProductByTypeListResponse>
2	···<dt:productList count="19" total="19" offset="0">	dt:ProductList	[1..1]	Список продукции total - всего записей; offset - смещение относительно первого элемента; count - количество выводимых записей.
3	······<dt:product>	dt:Product	[0..*]	Продукция второй уровень иерархического справочника продукции ИС Меркурий
4	·········<bs:uuid>	bs:UUID	[1..1]	Идентификатор версии продукции.	<bs:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</bs:uuid>
5	·········<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор продукции.	<bs:guid>362aa885-9b9f-ae95-05d0-f9570f4fbdc6</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:code>	bs:String255	[1..1]	Код ТН ВЭД продукции.	<dt:code>0210, 1601, 1602</dt:code>
15	·········<dt:productType>	dt:ProductType	[1..1]	Тип продукции первый уровень иерархического справочника продукции ИС Меркурий	<dt:productType>5</dt:productType>
16	······</dt:product>
17	···</dt:productList>
18	</ws:getProductByTypeListResponse>

Описание ошибок

Ошибка	Описание
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" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getProductByTypeListRequest>
   	<bs:listOptions>
           <bs:count>3</bs:count>
           <bs:offset>0</bs:offset>
        </bs:listOptions>
        <dt:productType>5</dt:productType>
      </ws:getProductByTypeListRequest>
   </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:getProductByTypeListResponse 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:productList count="3" total="22" offset="0">
            <dt:product>
               <bs:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</bs:uuid>
               <bs:guid>e9fa27c7-c0e0-2f64-308c-c6409de238ae</bs:guid>
               <bs:active>true</bs:active>
               <bs:last>true</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2011-05-23T10:35:08+04:00</bs:createDate>
               <bs:updateDate>2011-05-23T10:35:08+04:00</bs:updateDate>
               <dt:name>готовые мясные продукты</dt:name>
               <dt:code>0210, 1601, 1602</dt:code>
               <dt:productType>5</dt:productType>
            </dt:product>
            <dt:product>
               <bs:uuid>31c94ff1-a217-f38d-6005-1aa5ca67e146</bs:uuid>
               <bs:guid>d34504bb-7a93-e1c8-4859-339eafd97c6c</bs:guid>
               <bs:active>true</bs:active>
               <bs:last>true</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2011-05-23T10:49:01+04:00</bs:createDate>
               <bs:updateDate>2011-05-23T10:49:01+04:00</bs:updateDate>
               <dt:name>молоко и молочная продукция</dt:name>
               <dt:code>0401-0406,1905,1517</dt:code>
               <dt:productType>5</dt:productType>
            </dt:product>
            <dt:product>
               <bs:uuid>84128278-7db4-1e11-da35-4ac7128569c6</bs:uuid>
               <bs:guid>5f157caa-8f3b-4666-d3b0-5df86f8afb66</bs:guid>
               <bs:active>true</bs:active>
               <bs:last>true</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2011-05-23T10:51:18+04:00</bs:createDate>
               <bs:updateDate>2011-05-23T10:51:18+04:00</bs:updateDate>
               <dt:name>яйца и продукты их переработки</dt:name>
               <dt:code>0407,0408,2103,2106,3502</dt:code>
               <dt:productType>5</dt:productType>
            </dt:product>
         </dt:productList>
      </v2:getProductByTypeListResponse>
   </soap:Body>
</soapenv:Envelope>

@@ Строка 34: / Строка 34: @@
 ! Тип
 ! Обязат.
-! Описание
+! Описание (нажмите [...] для отображения дополнительного описания)
-! Пример
 |-
-|1
+|001
-|style="font-weight: bold; font-family: Courier;" |<ws:getProductByTypeListRequest>
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getProductByTypeListRequest>'''}}
 |
 |
-|
+| 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;">Номер элемента, по которому осуществляется смещение первого элемента списка. </span>
-|style="font-family: Courier;" |<bs:offset>2</bs:offset>
+<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;" |
 |-
-|2
+|006
-|style="font-weight: bold; font-family: Courier;" |···&lt;dt:productType>
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}productType>'''}}{{color|#131313|5}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}productType>'''}}
 |[[ProductType_v2.0|dt:ProductType]]
 |[1..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>
-|style="font-family: Courier;" |&lt;dt:productType>5</dt:productType>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* первый уровень иерархического справочника продукции ИС Меркурий</div>
+</div>
 |-
-|3
+|007
-|style="font-weight: bold; font-family: Courier;" |</ws:getProductByTypeListRequest>
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getProductByTypeListRequest>'''}}
-|
 |
 |
-|style="font-family: Courier;" |
+| style="width:52em;"|
 |-
 |}