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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetSubProductByProductList''' предназначена для получения списка видов п…»)
 
 
(не показано 5 промежуточных версий этого же участника)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


{{столбцы}}
{{столбцы}}
Строка 22: Строка 21:
** [[UUID|bs:UUID]]
** [[UUID|bs:UUID]]
** [[ListOptions|bs:ListOptions]]
** [[ListOptions|bs:ListOptions]]
{{столбцы/конец}}
{{столбцы/конец}}-->


==Данные запроса==
===Входные данные===
* параметры выводимого списка.
* идентификатор продукта (2 уровень иерархического справочника)


===Объект getSubProductByProductListRequest===
===Выходные данные===
* данные запрошенного вида продукции (3 уровень иерархического справочника).


Корневой объект запроса.
==Спецификация запроса==
{| class="wikitable"
{| 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="&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</div>
</div>
|-
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|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="&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;">
* По умолчанию значение 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="&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;">
* второй уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByProductListRequest>'''}}
|
|
| style="width:52em;"|
|-
|-
| '''productGuid''' || Глобальный идентифкатор продукции, по которому производится отбор. || [[UUID|bs:UUID]] || 1
|}
|}


===Объект [[#Объект getSubProductByProductListRequest|..Request]]/'''listOptions'''===
==Спецификация ответа==
 
Объект содержит параметры запрашиваемого списка продукции.
 
{| class="wikitable"
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|-
! Поле !! Описание !! Тип данных !! Обязательность
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByProductListResponse>'''}}
|
|
| style="width:52em;"|
|-
|-
| '''count''' || Количество значений в списке.
|002
* По умолчанию значение равно 100;
|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"}}>'''}}
* Максимально допустимое значение равно 1000.
|[[SubProductList_v2.0|dt:SubProductList]]
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|[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 - количество выводимых записей.</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="&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;">
* третий уровень иерархического справочника продукции ИС Меркурий</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="&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 - запись не активна.</div>
</div>
|-
|-
| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|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="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
===Объект getSubProductByProductListResponse===
<span style="white-space:nowrap; font-weight: normal;">Описывает, является ли версия записи последней.
 
</span>
Корневой элемент ответа.
<div class="mw-collapsible-content" style="font-weight: normal;">
 
* true - да;
{| class="wikitable"
* 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:}}code>'''}}{{color|#131313|0207}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Код ТН ВЭД вида продукции.
|-
|014
|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;">Глобальный идентификатор продукции
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* второй уровень иерархического справочника продукции ИС Меркурий</div>
</div>
|-
|-
! Поле !! Описание !! Тип данных !! Обязательность
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}}
|
|
| style="width:52em;"|
|-
|-
| [[#Объект ..Response/subProductList|'''subProductList''']] || Список видов продукции указанной в запросе. || [[SubProductList|prod:SubProductList]] || 1
|016
|}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProductList>'''}}
 
|
===Объект [[#Объект getSubProductByProductListResponse |..Response]]/'''subProductList'''===
|
 
| style="width:52em;"|
Список продукции, полученной в результате запроса.
 
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип данных !! Обязательность
|017
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByProductListResponse>'''}}
|
|
| style="width:52em;"|
|-
|-
| '''[[#Объект ..Response/subProductList/subProduct|subProduct]]''' || Данные о продукции. || [[SubProduct|prod:SubProduct]] || 0..*
|}
|}
===Объект [[#Объект getProductByTypeListResponse |..Response]]/[[#Объект ..Response/subProductList|subProductList]]/'''subProduct'''===
Описание вида продукции.
{{Ветис.API ProductService Subproduct}}


==Описание ошибок==
==Описание ошибок==
Строка 99: Строка 253:


<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос данных 3 видов продукции со смещением 2 от начала списка.
Запрос первых 3 видов для продукции "Мясо птицы".
<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/"  
<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">
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"  
  <soapenv:Header/>
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base"  
  <soapenv:Body>
                  xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production">
      <ws:getSubProductByProductListRequest>
  <soapenv:Header/>
          <bs:listOptions>
  <soapenv:Body>
            <bs:count>3</bs:count>
    <ws:getSubProductByProductListRequest>
            <bs:offset>0</bs:offset>
      <base:listOptions>
        </bs:listOptions>
        <base:count>3</base:count>
        <dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
        <base:offset>2</base:offset>
      </ws:getSubProductByProductListRequest>
      </base:listOptions>
  </soapenv:Body>
      <prod:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</prod:productGuid>
    </ws:getSubProductByProductListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
Строка 126: Строка 277:
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getSubProductByProductListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"  
      <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">
                                          xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production"  
        <dt:subProductList count="3" total="23" offset="0">
                                          xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
            <dt:subProduct>
      <pro:subProductList count="3" total="23" offset="2">
              <bs:uuid>80161573-7639-2493-c5dd-e10f05935cce</bs:uuid>
        <pro:subProduct>
              <bs:guid>bcb270cd-84fa-f3ad-6e4b-705eb50d703f</bs:guid>
          <bs:uuid>41e78ed2-f727-ec66-4d76-25fda8c61316</bs:uuid>
              <bs:active>true</bs:active>
          <bs:guid>c7cf9fdc-6b23-def0-dc46-20c124bb793e</bs:guid>
              <bs:last>true</bs:last>
          <bs:active>true</bs:active>
              <bs:status>100</bs:status>
          <bs:last>true</bs:last>
              <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
          <bs:status>100</bs:status>
              <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
              <dt:name>курица домашняя: "не разделенная на части охлажденная"</dt:name>
          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
              <dt:code>020711</dt:code>
          <pro:name>курица домашняя: "части тушек обваленные, охлажденные"</pro:name>
              <dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
          <pro:code>0207131</pro:code>
            </dt:subProduct>
          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
            <dt:subProduct>
        </pro:subProduct>
              <bs:uuid>5d00323a-12ff-510c-f6f1-cb7a9a83f535</bs:uuid>
        <pro:subProduct>
              <bs:guid>5346cfed-86a5-4ba0-235e-5b0faa81fb87</bs:guid>
          <bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
              <bs:active>true</bs:active>
          <bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</bs:guid>
              <bs:last>true</bs:last>
          <bs:active>true</bs:active>
              <bs:status>100</bs:status>
          <bs:last>true</bs:last>
              <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
          <bs:status>100</bs:status>
              <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
              <dt:name>курица домашняя: "не разделенная на части мороженая"</dt:name>
          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
              <dt:code>020712</dt:code>
          <pro:name>курица домашняя: "части тушек необваленные, охлажденные"</pro:name>
              <dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
          <pro:code>0207132-0207137</pro:code>
            </dt:subProduct>
          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
            <dt:subProduct>
        </pro:subProduct>
              <bs:uuid>41e78ed2-f727-ec66-4d76-25fda8c61316</bs:uuid>
        <pro:subProduct>
              <bs:guid>c7cf9fdc-6b23-def0-dc46-20c124bb793e</bs:guid>
          <bs:uuid>ca4a9f4d-3845-4194-d4b6-07f3d8e6f3e0</bs:uuid>
              <bs:active>true</bs:active>
          <bs:guid>4c7ee80b-d421-5239-7d98-a764707b81f8</bs:guid>
              <bs:last>true</bs:last>
          <bs:active>true</bs:active>
              <bs:status>100</bs:status>
          <bs:last>true</bs:last>
              <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
          <bs:status>100</bs:status>
              <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
          <bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
              <dt:name>курица домашняя: "части тушек обваленные, охлажденные"</dt:name>
          <bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
              <dt:code>0207131</dt:code>
          <pro:name>курица домашняя: "части тушек обваленные мороженые"</pro:name>
              <dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
          <pro:code>0207141</pro:code>
            </dt:subProduct>
          <pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
        </dt:subProductList>
        </pro:subProduct>
      </v2:getSubProductByProductListResponse>
      </pro:subProductList>
  </soap:Body>
    </ws:getSubProductByProductListResponse>
  </S:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>

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

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

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

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

  • параметры выводимого списка.
  • идентификатор продукта (2 уровень иерархического справочника)

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

  • данные запрошенного вида продукции (3 уровень иерархического справочника).

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getSubProductByProductListRequest>
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:productGuid>GUID</dt:productGuid> bs:UUID [1..1]

Глобальный идентификатор продукции

  • второй уровень иерархического справочника продукции ИС Меркурий
007 </ws:getSubProductByProductListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getSubProductByProductListResponse>
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 ·········<dt:name>мясо птицы</dt:name> bs:String255 [1..1] Название вида продукции.
013 ·········<dt:code>0207</dt:code> bs:String255 [1..1] Код ТН ВЭД вида продукции.
014 ·········<dt:productGuid>GUID</dt:productGuid> bs:UUID [1..1]

Глобальный идентификатор продукции

  • второй уровень иерархического справочника продукции ИС Меркурий
015 ······</dt:subProduct>
016 ···</dt:subProductList>
017 </ws:getSubProductByProductListResponse>

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

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

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

Запрос первых 3 видов для продукции "Мясо птицы".

<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>


Ответ на запрос.

<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>