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

Текущая версия на 16:01, 27 сентября 2020

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

Операция GetSubProductChangesList предназначена для получения списка изменённых видов продукции (3 уровень иерархического справочника). В список попадают записи, дата изменения которых попадает во временной интервал, указанный в запросе. Выполнение операции заканчивается либо возвращением списка всех версий видов продукции, последних и не последних (last=true, last=false), актуальных и не актуальных (active=true, active = false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

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

параметры запрашиваемого списка;
интервал дат, за которые нужно получить изменения.

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

список видов продукции, изменённых за указанный период времени.

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getSubProductChangeListRequest>
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	···<bs:updateDateInterval>	bs:DataInterval	[1..1]	Интервал времени обновления. В список попадают все записи, дата обновлений которых попадает в указанный интервал.
007	······<bs:beginDate>2017-07-07T00:00:00</bs:beginDate>	xs:dateTime	[1..1]	Начало временного интервала.
008	······<bs:endDate>2017-07-25T00:00:00</bs:endDate>	xs:dateTime	[0..1]	Конец временного интервала.
009	···</bs:updateDateInterval>
010	</ws:getSubProductChangeListRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getSubProductChangeListResponse>
002	···<dt:subProductList total="2" offset="0" count="2">	dt:SubProductList	[1..1]	Список видов продукции. total - всего записей; offset - смещение относительно первого элемента; count - количество выводимых записей.
003	······<dt:subProduct>	dt:SubProduct	[0..*]	Вид продукции. третий уровень иерархического справочника продукции ИС Меркурий
004	·········<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии вида продукции.
005	·········<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор вида продукции.
006	·········<bs:active>true</bs:active>	xs:boolean	[1..1]	Описание, является ли запись активной. true - запись активна; false - запись не активна.
007	·········<bs:last>true</bs:last>	xs:boolean	[1..1]	Описание, является ли версия записи последней. true - да; false - нет.
008	·········<bs:status>100</bs:status>	bs:VersionStatus	[1..1]	Статус версии записи.
009	·········<bs:createDate>2017-07-07T12:00:00</bs:createDate>	xs:DateTime	[1..1]	Дата создания записи.
010	·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>	xs:DateTime	[1..1]	Дата изменения записи.
011	·········<bs:previous>UUID</bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи.
012	·········<bs:next>UUID</bs:next>	bs:UUID	[0..1]	Идентификатор следующей версии записи.
013	·········<dt:name>мясо птицы</dt:name>	bs:String255	[1..1]	Название вида продукции.
014	·········<dt:code>0207</dt:code>	bs:String255	[1..1]	Код ТН ВЭД вида продукции.
015	·········<dt:productGuid>GUID</dt:productGuid>	bs:UUID	[1..1]	Глобальный идентификатор продукции. второй уровень иерархического справочника продукции ИС Меркурий
016	······</dt:subProduct>
017	···</dt:subProductList>
018	</ws:getSubProductChangeListResponse>

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

Ошибка	Описание
InternalServiceFault	Внутренняя ошибка сервиса.
IncorrectRequestFault	Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос списка первых трех изменённых видов продукции с 20.10.2016 по текущий день без смещения.

<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:getSubProductChangesListRequest>
         <bs:listOptions>
            <bs:count>3</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
         <bs:updateDateInterval>
            <bs:beginDate>2016-10-20T00:00:00</bs:beginDate>
         </bs:updateDateInterval>   
      </ws:getSubProductChangesListRequest>
   </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:getSubProductChangesListResponse 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:subProductList count="3" total="946" offset="0">
            <dt:subProduct>
               <bs:uuid>c51f5855-ea43-116e-3a5b-f7dcd2766d8a</bs:uuid>
               <bs:guid>2160cc9f-0380-6200-dce9-0f0b3c86a8aa</bs:guid>
               <bs:active>false</bs:active>
               <bs:last>false</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
               <bs:updateDate>2016-11-11T14:03:00+03:00</bs:updateDate>
               <bs:next>619e5808-3262-4c19-aaa3-77ce377524ee</bs:next>
               <dt:name>молочная паста</dt:name>
               <dt:code>0405</dt:code>
               <dt:productGuid>686b55f7-c199-9788-5ee5-a755eb2b8d2a</dt:productGuid>
            </dt:subProduct>
            <dt:subProduct>
               <bs:uuid>6d71c9e1-3cf4-2afb-9d9a-75ea2ab95a12</bs:uuid>
               <bs:guid>c847eca1-641f-24e7-a44a-c71c28fb377f</bs:guid>
               <bs:active>false</bs:active>
               <bs:last>false</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
               <bs:updateDate>2017-03-10T10:06:36+03:00</bs:updateDate>
               <bs:next>4a6238db-dda6-4b51-8910-6d1cc6e63d69</bs:next>
               <dt:name>икра лососевых пород рыб мороженая соленая</dt:name>
               <dt:code>1604</dt:code>
               <dt:productGuid>46fde18a-f6af-f7b0-de47-044281271112</dt:productGuid>
            </dt:subProduct>
            <dt:subProduct>
               <bs:uuid>b694de27-45e0-ea26-c936-684f7db0dfd4</bs:uuid>
               <bs:guid>799e561f-4228-9bd5-fa45-11a6db084dfc</bs:guid>
               <bs:active>false</bs:active>
               <bs:last>false</bs:last>
               <bs:status>100</bs:status>
               <bs:createDate>2009-11-17T14:45:40+03:00</bs:createDate>
               <bs:updateDate>2016-11-11T14:03:00+03:00</bs:updateDate>
               <bs:next>097c5951-aae6-4e1a-9152-cca3f9f8d295</bs:next>
               <dt:name>белок молочный сухой</dt:name>
               <dt:code>3504</dt:code>
               <dt:productGuid>686b55f7-c199-9788-5ee5-a755eb2b8d2a</dt:productGuid>
            </dt:subProduct>
         </dt:subProductList>
      </v2:getSubProductChangesListResponse>
   </soap:Body>
</soapenv:Envelope>

@@ Строка 122: / Строка 122: @@
 ! Тип
 ! Обязат.
-! Описание
+! Описание (нажмите [...] для отображения дополнительного описания)
-! Пример
 |-
-|1
+|001
-|style="font-weight: bold; font-family: Courier;" |<ws:getSubProductChangesListResponse>
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductChangeListResponse>'''}}
 |
 |
-|
+| style="width:52em;"|
-|style="font-family: Courier;" |
 |-
-|2
+|002
-|style="font-weight: bold; font-family: Courier;" |···&lt;dt:subProductList count="23" total="23" offset="0">
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProductList {{color|Red|total&#61;}}{{color|#007f15|"2"}} {{color|Red|offset&#61;}}{{color|#007f15|"0"}} {{color|Red|count&#61;}}{{color|#007f15|"2"}}>'''}}
 |[[SubProductList_v2.0|dt:SubProductList]]
 |[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>
+<div class="mw-collapsible-content" style="font-weight: normal;">
 * total - всего записей;
 * offset - смещение относительно первого элемента;
-* count - количество выводимых записей.
+* count - количество выводимых записей.</div>
-|style="font-family: Courier;" |
+</div>
 |-
-|3
+|003
-|style="font-weight: bold; font-family: Courier;" |······&lt;dt:subProduct>
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProduct>'''}}
 |[[SubProduct_v2.0|dt:SubProduct]]
 |[0..*]
-|Вид продукции
+|<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;">Вид продукции.
-|style="font-family: Courier;" |
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* третий уровень иерархического справочника продукции ИС Меркурий</div>
+</div>
 |-
-|4
+|004
-|style="font-weight: bold; font-family: Courier;" |·········<bs:uuid>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
 |[[UUID|bs:UUID]]
 |[1..1]
-|Идентификатор версии вида продукции.
+| style="width:52em;"| Идентификатор версии вида продукции.
-|style="font-family: Courier;" |<bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
 |-
-|5
+|005
-|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
 |[[UUID|bs:UUID]]
 |[1..1]
-|Глобальный идентификатор вида продукции.
+| style="width:52em;"| Глобальный идентификатор вида продукции.
-|style="font-family: Courier;" |<bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
 |-
-|6
+|006
-|style="font-weight: bold; font-family: Courier;" |·········<bs:active>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
 |[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
 |[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>
+<div class="mw-collapsible-content" style="font-weight: normal;">
 * true - запись активна;
-* false - запись не активна.
+* false - запись не активна.</div>
-|style="font-family: Courier;" |<bs:active>true</bs:active>
+</div>
 |-
-|7
+|007
-|style="font-weight: bold; font-family: Courier;" |·········<bs:last>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
 |[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
 |[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>
+<div class="mw-collapsible-content" style="font-weight: normal;">
 * true - да;
-* false - нет.
+* false - нет. </div>
-|style="font-family: Courier;" |<bs:last>true</bs:last>
+</div>
 |-
-|8
+|008
-|style="font-weight: bold; font-family: Courier;" |·········<bs:status>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|100}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
 |[[VersionStatus|bs:VersionStatus]]
 |[1..1]
-|Статус версии записи.
+| style="width:52em;"| Статус версии записи.
-|style="font-family: Courier;" |<bs:status>100</bs:status>
 |-
-|9
+|009
-|style="font-weight: bold; font-family: Courier;" |·········<bs:createDate>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
 |[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
 |[1..1]
-|Дата создания записи.
+| style="width:52em;"| Дата создания записи.
-|style="font-family: Courier;" |<bs:createDate>2017-07-07T12:00:00</bs:createDate>
 |-
-|10
+|010
-|style="font-weight: bold; font-family: Courier;" |·········<bs:updateDate>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
 |[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
 |[1..1]
-|Дата изменения записи.
+| style="width:52em;"| Дата изменения записи.
-|style="font-family: Courier;" |<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
 |-
-|11
+|011
-|style="font-weight: bold; font-family: Courier;" |·········<bs:previous>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
 |[[UUID|bs:UUID]]
 |[0..1]
-|Идентификатор предыдущей версии записи.
+| style="width:52em;"| Идентификатор предыдущей версии записи.
-|style="font-family: Courier;" |<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
 |-
-|12
+|012
-|style="font-weight: bold; font-family: Courier;" |·········<bs:next>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}next>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}next>'''}}
 |[[UUID|bs:UUID]]
 |[0..1]
-|Идентификатор следующей версии записи.
+| style="width:52em;"| Идентификатор следующей версии записи.
-|style="font-family: Courier;" |<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
 |-
-|13
+|013
-|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:name>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|мясо птицы}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
 |[[String255|bs:String255]]
 |[1..1]
-|Название вида продукции.
+| style="width:52em;"| Название вида продукции.
-|style="font-family: Courier;" |&lt;dt:name>мясо птицы</dt:name>
 |-
-|14
+|014
-|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:code>
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|0207}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
 |[[String255|bs:String255]]
 |[1..1]
-|Код ТН ВЭД вида продукции.
+| style="width:52em;"| Код ТН ВЭД вида продукции.
-|style="font-family: Courier;" |&lt;dt:code>0207</dt:code>
 |-
-|15
+|015
-|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:productGuid
+|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}productGuid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}productGuid>'''}}
 |[[UUID|bs:UUID]]
 |[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;">Глобальный идентификатор продукции.
-|style="font-family: Courier;" |&lt;dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* второй уровень иерархического справочника продукции ИС Меркурий</div>
+</div>
 |-
-|16
+|016
-|style="font-weight: bold; font-family: Courier;" |······</dt:subProduct>
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}}
-|
 |
 |
-|style="font-family: Courier;" |
+| style="width:52em;"|
 |-
-|17
+|017
-|style="font-weight: bold; font-family: Courier;" |···</dt:subProductList>
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProductList>'''}}
-|
 |
 |
-|style="font-family: Courier;" |
+| style="width:52em;"|
 |-
-|18
+|018
-|style="font-weight: bold; font-family: Courier;" |</ws:getSubProductChangesListResponse>
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductChangeListResponse>'''}}
-|
 |
 |
-|style="font-family: Courier;" |
+| style="width:52em;"|
 |-
 |}