Romanov-av: Новая страница: «==Общие сведения== Операция '''GetSubProductByProductList''' предназначена для получения списка видов п...»

2023-03-30T21:32:59Z

Новая страница: «==Общие сведения== Операция '''GetSubProductByProductList''' предназначена для получения списка видов п...»

Новая страница

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

Операция '''GetSubProductByProductList''' предназначена для получения списка видов продукции (3 уровень иерархического справочника), отфильтрованного по указанному продукту (2 уровень иерархического справочника). В список попадают только актуальные последние записи (active=true, last=true). Метод поддерживает возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка видов продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByProductListRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|[[ListOptions|bs:ListOptions]]
|[0..1]
| style="width:52em;"| Параметры запрашиваемого списка.
|-
|003
|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=" ... " 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</div>
</div>
|-
|004
|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=" ... " 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;">
* По умолчанию значение 0.</div>
</div>
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
| style="width:52em;"|
|-
|006
|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=" ... " 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;">
* второй уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByProductListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}

==Спецификация ответа==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByProductListResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProductList {{color|Red|total=}}{{color|#007f15|"2"}} {{color|Red|offset=}}{{color|#007f15|"0"}} {{color|Red|count=}}{{color|#007f15|"2"}}>'''}}
|[[SubProductList_v2.0|dt:SubProductList]]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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 - количество выводимых записей.</div>
</div>
|-
|003
|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=" ... " 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;">
* третий уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|004
|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;"| Идентификатор версии вида продукции.
|-
|005
|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;"| Глобальный идентификатор вида продукции.
|-
|006
|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=" ... " 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 - запись не активна.</div>
</div>
|-
|007
|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=" ... " 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 - нет. </div>
</div>
|-
|008
|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;"| Статус версии записи.
|-
|009
|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;"| Дата создания записи.
|-
|010
|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;"| Дата изменения записи.
|-
|011
|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;"| Идентификатор предыдущей версии записи.
|-
|012
|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;"| Название вида продукции.
|-
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}englishName>'''}}{{color|#131313|poultry meat}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}englishName>'''}}
|[[String255|bs:String255]]
|[0..1]
| style="width:52em;"| Английское название вида продукции.
|-
|014
|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;"| Код ТН ВЭД вида продукции.
|-
|015
|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=" ... " 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;">
* второй уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|016
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProductList>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByProductListResponse>'''}}
|
|
| style="width:52em;"|
|-
|}

==Описание ошибок==
{| class="wikitable"
|-
! Ошибка !! Описание
|-
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
|-
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
|}

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

<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос первых 3 видов для продукции "Мясо птицы".
<div class = "mw-collapsible-content">
<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" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
<soapenv:Header/>
<soapenv:Body>
<ws:getSubProductByProductListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
</ws:getSubProductByProductListRequest>
</soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<v2:getSubProductByProductListResponse 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="23" offset="0">
<dt:subProduct>
<bs:uuid>80161573-7639-2493-c5dd-e10f05935cce</bs:uuid>
<bs:guid>bcb270cd-84fa-f3ad-6e4b-705eb50d703f</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:code>020711</dt:code>
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
</dt:subProduct>
<dt:subProduct>
<bs:uuid>5d00323a-12ff-510c-f6f1-cb7a9a83f535</bs:uuid>
<bs:guid>5346cfed-86a5-4ba0-235e-5b0faa81fb87</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:code>020712</dt:code>
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
</dt:subProduct>
<dt:subProduct>
<bs:uuid>41e78ed2-f727-ec66-4d76-25fda8c61316</bs:uuid>
<bs:guid>c7cf9fdc-6b23-def0-dc46-20c124bb793e</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:code>0207131</dt:code>
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
</dt:subProduct>
</dt:subProductList>
</v2:getSubProductByProductListResponse>
</soap:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>

Exportcenter:GetSubProductByProductList:v2.2 - История изменений

Romanov-av: Новая страница: «==Общие сведения== Операция '''GetSubProductByProductList''' предназначена для получения списка видов п...»