GetSubProductByGuid v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Новая страница: «==Общие сведения== Операция '''GetSubProductByGuid''' предназначена для получения актуальной версии…» |
|||
| (не показано 5 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Операция '''GetSubProductByGuid''' предназначена для получения актуальной версии записи о виде продукции по глобальному идентификатору (active=true, last=true). Выполнение операции заканчивается либо возвратом объекта записи вида продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. | Операция '''GetSubProductByGuid''' предназначена для получения актуальной версии записи о виде продукции (3 уровень иерархического справочника) по глобальному идентификатору (active=true, last=true). Выполнение операции заканчивается либо возвратом объекта записи вида продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. | ||
<!--===Используемые пространства имён и типы=== | |||
===Используемые пространства имён и типы=== | |||
{{столбцы}} | {{столбцы}} | ||
| Строка 17: | Строка 16: | ||
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>) | * [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>) | ||
** [[UUID|bs:UUID]] | ** [[UUID|bs:UUID]] | ||
{{столбцы/конец}} | {{столбцы/конец}}--> | ||
=== | ===Входные данные=== | ||
* глобальный уникальный идентификатор вида продукции. | * глобальный уникальный идентификатор вида продукции. | ||
=== | ===Выходные данные=== | ||
* данные запрошенного вида продукции. | * данные запрошенного вида продукции. | ||
== | ==Спецификация запроса== | ||
{| class="wikitable" | {| class="wikitable" | ||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByGuidRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|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] | |||
|<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> | |||
|- | |- | ||
|003 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByGuidRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |- | ||
|} | |} | ||
== | ==Спецификация ответа== | ||
{| class="wikitable" | {| class="wikitable" | ||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getSubProductByGuidResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProduct>'''}} | |||
|[[SubProduct_v2.0|dt:SubProduct]] | |||
|[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> | |||
|- | |||
|003 | |||
|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;"| Идентификатор версии вида продукции. | |||
|- | |||
|004 | |||
|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;"| Глобальный идентификатор вида продукции. | |||
|- | |||
|005 | |||
|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> | |||
|- | |||
|006 | |||
|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> | |||
|- | |||
|007 | |||
|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;"| Статус версии записи. | |||
|- | |||
|008 | |||
|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;"| Дата создания записи. | |||
|- | |||
|009 | |||
|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;"| Дата изменения записи. | |||
|- | |||
|010 | |||
|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;"| Идентификатор предыдущей версии записи. | |||
|- | |||
|011 | |||
|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;"| Название вида продукции. | |||
|- | |||
|012 | |||
|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;"| Код ТН ВЭД вида продукции. | |||
|- | |||
|013 | |||
|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> | |||
|- | |||
|014 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |- | ||
|015 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getSubProductByGuidResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |- | ||
|} | |} | ||
==Описание ошибок== | ==Описание ошибок== | ||
| Строка 75: | Строка 194: | ||
<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"> | ||
<soapenv:Header/> | |||
<soapenv:Body> | |||
<ws:getSubProductByGuidRequest> | |||
<bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid> | |||
</ws:getSubProductByGuidRequest> | |||
</soapenv:Body> | |||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Строка 94: | Строка 211: | ||
<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/"> | ||
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> | |||
<v2:getSubProductByGuidResponse 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:subProduct> | |||
<bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid> | |||
<bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid> | |||
<bs:active>true</bs:active> | |||
<bs:last>true</bs:last> | |||
<bs:status>100</bs:status> | |||
<bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate> | |||
<bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate> | |||
<dt:name>мясо птицы</dt:name> | |||
<dt:code>0207</dt:code> | |||
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid> | |||
</dt:subProduct> | |||
</v2:getSubProductByGuidResponse> | |||
</soap:Body> | |||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Текущая версия от 12:54, 27 сентября 2020
Общие сведения
Операция GetSubProductByGuid предназначена для получения актуальной версии записи о виде продукции (3 уровень иерархического справочника) по глобальному идентификатору (active=true, last=true). Выполнение операции заканчивается либо возвратом объекта записи вида продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- глобальный уникальный идентификатор вида продукции.
Выходные данные
- данные запрошенного вида продукции.
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getSubProductByGuidRequest> | |||
| 002 | ···<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор вида продукции.
|
| 003 | </ws:getSubProductByGuidRequest> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getSubProductByGuidResponse> | |||
| 002 | ···<dt:subProduct> | dt:SubProduct | [1..1] | Вид продукции.
|
| 003 | ······<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии вида продукции. |
| 004 | ······<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор вида продукции. |
| 005 | ······<bs:active>true</bs:active> | xs:boolean | [1..1] | Описывает, является ли запись активной.
|
| 006 | ······<bs:last>true</bs:last> | xs:boolean | [1..1] | Описывает, является ли версия записи последней.
|
| 007 | ······<bs:status>100</bs:status> | bs:VersionStatus | [1..1] | Статус версии записи. |
| 008 | ······<bs:createDate>2017-07-07T12:00:00</bs:createDate> | xs:DateTime | [1..1] | Дата создания записи. |
| 009 | ······<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | xs:DateTime | [1..1] | Дата изменения записи. |
| 010 | ······<bs:previous>UUID</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи. |
| 011 | ······<dt:name>мясо птицы</dt:name> | bs:String255 | [1..1] | Название вида продукции. |
| 012 | ······<dt:code>0207</dt:code> | bs:String255 | [1..1] | Код ТН ВЭД вида продукции. |
| 013 | ······<dt:productGuid>GUID</dt:productGuid> | bs:UUID | [1..1] | Глобальный идентификатор продукции
|
| 014 | ···</dt:subProduct> | |||
| 015 | </ws:getSubProductByGuidResponse> |
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
| EntityNotFoundFault | Объект с заданными параметрами не найден в базе. |
Пример запроса
Запрос данных о виде продукции.
<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:getSubProductByGuidRequest>
<bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
</ws:getSubProductByGuidRequest>
</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:getSubProductByGuidResponse 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:subProduct>
<bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid>
<bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-12-21T21:15:06+03:00</bs:createDate>
<bs:updateDate>2008-12-21T21:15:06+03:00</bs:updateDate>
<dt:name>мясо птицы</dt:name>
<dt:code>0207</dt:code>
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid>
</dt:subProduct>
</v2:getSubProductByGuidResponse>
</soap:Body>
</soapenv:Envelope>