GetSubProductByUuid: различия между версиями
Перейти к навигации
Перейти к поиску
(Изменен блок "Общие сведения") |
|||
| Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Операция '''GetSubProductByUuid''' предназначена для получения информации о конкретной версии записи вида продукции по её уникальному идентификатору. | Операция '''GetSubProductByUuid''' предназначена для получения информации о конкретной версии записи вида продукции по её уникальному идентификатору. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. | ||
===Используемые пространства имён и типы=== | ===Используемые пространства имён и типы=== | ||
Версия 11:48, 7 декабря 2016
Общие сведения
Операция GetSubProductByUuid предназначена для получения информации о конкретной версии записи вида продукции по её уникальному идентификатору. Выполнение операции заканчивается либо возвратом записи той версии, которая значится под указанным UUID, то есть запись может быть не последней и/или не актуальной (active=false, last=false), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
Входные данные
- уникальный идентификатор версии вида продукции.
Выходные данные
- данные о виде продукции.
Данные запроса
Объект getSubProductByUuidRequest
Корневой элемент запроса. Содержит идентификатор версии записи вида продукции.
| Поле | Описание | Тип данных | Обязательность |
|---|---|---|---|
| UUID | Уникальный идентификатор версии записи вида продукции в реестре Россельхознадзора. | bs:UUID | 1 |
Данные ответа
Объект getSubProductByUuidResponse
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| subProduct | Объект содержит описание вида продукции. | prod:SubProduct | 1 |
Объект ..Response/subProduct
| Поле | Описание | Тип | Обязательность |
|---|---|---|---|
| UUID | Идентификатор версии записи о продукции в реестре Россельхознадзора. | bs:UUID | 1 |
| GUID | Глобальный идентификатор продукции в реестре Россельхознадзора. | bs:UUID | 1 |
| active | Флаг, указывающий на то, активна ли запись. | xs:boolean | 1 |
| last | Флаг, указывающий на то, является ли запись последней. | xs:boolean | 1 |
| status | Статус версии записи. | xs:string | 1 |
| createDate | Дата создания записи о продукции в реестре Россельхознадзора. | xs:date | 1 |
| updateDate | Дата последнего обновления записи в реестре Россельхознадзора. | xs:date | 1 |
| previous | Идентификатор предыдущей версии записи. | bs:UUID | 0..1 |
| next | Идентификатор следующей версии записи. | bs:UUID | 0..1 |
| name | Название вида продукции. | xs:string | 1 |
| code | Код ТН ВЭД вида продукции. | xs:string | 1 |
| englishName | Английское название вида продукции. | bs:String255 | 0..1 |
| productGuid | Идентификатор продукции (второй уровень иерархии справочника продукции). | bs:UUID | 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>d9078e32-353c-eb56-3839-9bc09e79bdf5</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:getSubProductByUuidResponse 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: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>
<pro:name>мясо птицы</pro:name>
<pro:code>0207</pro:code>
<pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
</pro:subProduct>
</ws:getSubProductByUuidResponse>
</S:Body>
</soapenv:Envelope>
