GetProductByUuid: различия между версиями
(не показано 19 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Операция '''GetProductByUuid''' предназначена для получения записи продукции по идентификатору версии записи.Уникальный идентификатор версии записи продукции содержится в ветеринарных сертификатах. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. | |||
===Используемые пространства имён и типы=== | ===Используемые пространства имён и типы=== | ||
Строка 17: | Строка 17: | ||
** [[UUID|bs:UUID]] | ** [[UUID|bs:UUID]] | ||
{{столбцы/конец}} | {{столбцы/конец}} | ||
===[[#Объект getProductByUuidRequest|Входные данные]]=== | |||
* уникальный идентификатор версии записи продукции. | |||
===[[#Объект getProductByUuidResponse |Выходные данные]]=== | |||
* данные о продукции. | |||
==Данные запроса== | ==Данные запроса== | ||
Строка 39: | Строка 45: | ||
! Поле !! Описание !! Тип данных !! Обязательность | ! Поле !! Описание !! Тип данных !! Обязательность | ||
|- | |- | ||
| '''UUID''' || Уникальный идентификатор версии записи продукции в реестре | | '''UUID''' || Уникальный идентификатор версии записи продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | ||
|} | |} | ||
Строка 74: | Строка 80: | ||
! Поле !! Описание !! Тип данных !! Обязательность | ! Поле !! Описание !! Тип данных !! Обязательность | ||
|- | |- | ||
| [[#Объект ..Response/product|'''product''']] || | | [[#Объект ..Response/product|'''product''']] || Объект, содержащий сведения о продукции. || [[Product|prod:Product]] || 1 | ||
|} | |} | ||
===Объект [[Объект getProductByUuidResponse|..Response]]/'''product'''=== | ===Объект [[#Объект getProductByUuidResponse|..Response]]/'''product'''=== | ||
Объект содержит свойства возвращаемой продукции. | Объект содержит свойства возвращаемой продукции. | ||
{{Ветис.API ProductService Product|1}} | |||
==Описание ошибок== | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! | ! Ошибка !! Описание | ||
|- | |- | ||
| ''' | | '''InternalServiceFault''' || Внутренняя ошибка сервиса. | ||
|- | |- | ||
| ''' | | '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. | ||
|- | |- | ||
| ''' | | '''EntityNotFoundFault''' || Объект с заданными параметрами не найден в базе. | ||
|} | |} | ||
==Пример запроса== | ==Пример запроса== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Запрос данных о продукции "Готовые мясные продукты" | Запрос на получение данных о продукции "Готовые мясные продукты". | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
Строка 117: | Строка 109: | ||
xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions" | xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions" | ||
xmlns:base="http://api.vetrf.ru/schema/cdm/base"> | xmlns:base="http://api.vetrf.ru/schema/cdm/base"> | ||
<soapenv:Header/> | |||
<soapenv:Body> | |||
<ws:getSubProductByUuidRequest> | |||
<base:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</base:uuid> | |||
</ws:getSubProductByUuidRequest> | |||
</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/"> | |||
<S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> | |||
<ws:getProductByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" | |||
xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production" | |||
xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"> | |||
<pro: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+03:00</bs:createDate> | |||
<bs:updateDate>2011-05-23T10:35:08+03:00</bs:updateDate> | |||
<pro:name>готовые мясные продукты</pro:name> | |||
<pro:code>0210, 1601, 1602</pro:code> | |||
<pro:productType>5</pro:productType> | |||
</pro:product> | |||
</ws:getProductByUuidResponse> | |||
</S:Body> | |||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
</div> | </div> | ||
[[Category:Ветис.API]] | |||
[[Category:ProductService]] | |||
[[Category:Реестры]] |
Текущая версия на 09:43, 16 декабря 2016
Общие сведения
Операция GetProductByUuid предназначена для получения записи продукции по идентификатору версии записи.Уникальный идентификатор версии записи продукции содержится в ветеринарных сертификатах. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
Входные данные
- уникальный идентификатор версии записи продукции.
Выходные данные
- данные о продукции.
Данные запроса
Объект getProductByUuidRequest
Корневой элемент запроса.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Уникальный идентификатор версии записи продукции в реестре Россельхознадзора. | bs:UUID | 1 |
Данные ответа
Объект getProductByUuidResponse
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
product | Объект, содержащий сведения о продукции. | prod:Product | 1 |
Объект ..Response/product
Объект содержит свойства возвращаемой продукции.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
UUID | Идентификатор версии записи продукции в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор продукции в реестре Россельхознадзора. | bs:UUID | 1 |
active | Флаг, указывающий на то, активна ли запись. | xs:boolean | 1 |
last | Флаг, указывающий на то, является ли запись последней. | xs:boolean | 1 |
status | Статус версии записи. | xs:string | 1 |
createDate | Дата создания записи о продукции в реестре Росcельхознадзора. | xs:dateTime | 1 |
updateDate | Дата последнего обновления записи в реестре Россельхознадзора. | xs:dateTime | 1 |
previous | Идентификатор предыдущей версии записи. | bs:UUID | 0..1 |
next | Идентификатор следующей версии записи. | bs:UUID | 0..1 |
name | Название продукции. | xs:string | 1 |
code | Код ТН ВЭД продукции. | xs:string | 1 |
productType | Тип продукции (первый уровень иерархии справочника продукции). | prod:ProductType | 1 |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
EntityNotFoundFault | Объект с заданными параметрами не найден в базе. |
Пример запроса
Запрос на получение данных о продукции "Готовые мясные продукты".
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions"
xmlns:base="http://api.vetrf.ru/schema/cdm/base">
<soapenv:Header/>
<soapenv:Body>
<ws:getSubProductByUuidRequest>
<base:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</base:uuid>
</ws:getSubProductByUuidRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<ws:getProductByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
xmlns:pro="http://api.vetrf.ru/schema/cdm/argus/production"
xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/production/ws-definitions">
<pro: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+03:00</bs:createDate>
<bs:updateDate>2011-05-23T10:35:08+03:00</bs:updateDate>
<pro:name>готовые мясные продукты</pro:name>
<pro:code>0210, 1601, 1602</pro:code>
<pro:productType>5</pro:productType>
</pro:product>
</ws:getProductByUuidResponse>
</S:Body>
</soapenv:Envelope>