GetProductItemByUuid: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Операция '''GetProductItemByUuid''' предназначена для получения последней записи о номенклатуре производителя идентификатору версии записи. Запись может быть не последней и не актуальной (last=false, active=false) | |||
===Используемые пространства имён и типы=== | ===Используемые пространства имён и типы=== | ||
Строка 16: | Строка 16: | ||
** [[UUID|bs:UUID]] | ** [[UUID|bs:UUID]] | ||
{{столбцы/конец}} | {{столбцы/конец}} | ||
===[[#Объект getProductItemByUuidRequest|Входные данные]]=== | |||
* идентификатор версии записи номенклатуры производителя. | |||
===[[#Объект getProductItemByUuidResponse|Выходные данные]]=== | |||
* данные записи номенклатуры производителя. | |||
==Данные запроса== | ==Данные запроса== | ||
===Объект getProductItemByUuidRequest=== | ===Объект getProductItemByUuidRequest=== | ||
Строка 39: | Строка 33: | ||
! Поле !! Описание !! Тип данных !! Обязательность | ! Поле !! Описание !! Тип данных !! Обязательность | ||
|- | |- | ||
| '''UUID''' || | | '''UUID''' || Идентификатор версии записи наименования номенклатуры производителя. || [[UUID|bs:UUID]] || 1 | ||
|} | |} | ||
==Данные ответа== | ==Данные ответа== | ||
===Объект getProductItemByUuidResponse=== | ===Объект getProductItemByUuidResponse=== | ||
Строка 75: | Строка 46: | ||
! Поле !! Описание !! Тип данных !! Обязательность | ! Поле !! Описание !! Тип данных !! Обязательность | ||
|- | |- | ||
| [[#Объект ..Response/productItem|'''productItem''']] || Объект, описывающий номенклатуру производителя || [[ProductItem|prod:ProductItem]] || 0..1 | | [[#Объект ..Response/productItem|'''productItem''']] || Объект, описывающий номенклатуру производителя. || [[ProductItem|prod:ProductItem]] || 0..1 | ||
|} | |} | ||
===Объект [[#Объект getProductItemByUuidResponse|..Response]]/'''productItem'''=== | ===Объект [[#Объект getProductItemByUuidResponse|..Response]]/'''productItem'''=== | ||
{{Ветис.API ProductService ProductItem}} | бъект содержит данные о единице номенклатуры продукции. | ||
<!-- {{Ветис.API ProductService ProductItem}} --> | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Тип !! Обязательность | |||
|- | |||
| '''UUID''' || Идентификатор версии записи о номенклатуре производителя в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный идентификатор номенклатуры производителя в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1 | |||
|- | |||
| '''status''' || Статус версии записи. || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|- | |||
| '''createDate''' || Дата создания записи о номенклатуре производителя в реестре Россельхознадзора. || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1 | |||
|- | |||
| '''updateDate''' || Дата последнего обновления записи в реестре Россельхознадзора. || [https://www.w3.org/TR/xmlschema-2/#date xs:date] || 1 | |||
|- | |||
| '''previous''' || Идентификатор предыдущей версии записи. || [[UUID|bs:UUID]] || 0..1 | |||
|- | |||
| '''next''' || Идентификатор следующей версии записи. || [[UUID|bs:UUID]] || 0..1 | |||
|- | |||
| '''name''' || Название номенклатуры производителя. || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|- | |||
| '''code''' || Код ТН ВЭД номенклатуры производителя. || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1 | |||
|- | |||
| '''productType''' || Тип продукции (первый уровень иерархии справочника продукции). || [[ProductType|prod:ProductType]] || 0..1 | |||
|- | |||
| [[#Объект ..Response/productItem/product|'''product''']] || Продукция (второй уровень иерархии справочника продукции). || [[Product|prod:Product]] || 0..1 | |||
|- | |||
| [[#Объект ..Response/productItem/subProduct|'''subProduct''']] || Вид продукции (третий уровень иерархии справочника продукции). || [[SubProduct|prod:SubProduct]] || 0..1 | |||
|- | |||
| '''correspondsToGost''' || Соответствует ли указанная продукция ГОСТу. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 0..1 | |||
|- | |||
| '''gost''' || ГОСТ. || [[String255|bs:String255]] || 0..1 | |||
|} | |||
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/[[#Объект ..Response/productItem|productItem]]/'''product'''=== | |||
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Текст заголовка !! Текст заголовка | |||
|- | |||
| '''UUID''' || Идентификатор версии записи о продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный идентификатор продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|} | |||
===Объект [[#Объект getProductItemByGuidResponse|..Response]]/[[#Объект ..Response/productItem|productItem]]/'''subProduct'''=== | |||
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы. | |||
{| class="wikitable" | |||
|- | |||
! Поле !! Описание !! Текст заголовка !! Текст заголовка | |||
|- | |||
| '''UUID''' || Идентификатор версии записи о виде продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|- | |||
| '''GUID''' || Глобальный идентификатор вида продукции в реестре Россельхознадзора. || [[UUID|bs:UUID]] || 1 | |||
|} | |||
==Описание ошибок== | |||
{| class="wikitable" | |||
|- | |||
! Ошибка !! Описание | |||
|- | |||
| '''InternalServiceFault''' || Внутренняя ошибка сервиса. | |||
|- | |||
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. | |||
|- | |||
| '''EntityNotFoundFault''' || Объект с заданными параметрами не найден в базе. | |||
|} | |||
==Пример запроса== | ==Пример запроса== |
Версия 14:19, 16 ноября 2016
Общие сведения
Операция GetProductItemByUuid предназначена для получения последней записи о номенклатуре производителя идентификатору версии записи. Запись может быть не последней и не актуальной (last=false, active=false)
Используемые пространства имён и типы
|
Входные данные
- идентификатор версии записи номенклатуры производителя.
Выходные данные
- данные записи номенклатуры производителя.
Данные запроса
Объект getProductItemByUuidRequest
Корневой элемент запроса.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
UUID | Идентификатор версии записи наименования номенклатуры производителя. | bs:UUID | 1 |
Данные ответа
Объект getProductItemByUuidResponse
Корневой объект ответа. Содержит информацию о запрашиваемой продукции.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
productItem | Объект, описывающий номенклатуру производителя. | prod:ProductItem | 0..1 |
Объект ..Response/productItem
бъект содержит данные о единице номенклатуры продукции.
Поле | Описание | Тип | Обязательность |
---|---|---|---|
UUID | Идентификатор версии записи о номенклатуре производителя в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор номенклатуры производителя в реестре Россельхознадзора. | bs:UUID | 1 |
active | Флаг, указывающий на то, активна ли запись. | 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 |
productType | Тип продукции (первый уровень иерархии справочника продукции). | prod:ProductType | 0..1 |
product | Продукция (второй уровень иерархии справочника продукции). | prod:Product | 0..1 |
subProduct | Вид продукции (третий уровень иерархии справочника продукции). | prod:SubProduct | 0..1 |
correspondsToGost | Соответствует ли указанная продукция ГОСТу. | xs:boolean | 0..1 |
gost | ГОСТ. | bs:String255 | 0..1 |
Объект ..Response/productItem/product
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.
Поле | Описание | Текст заголовка | Текст заголовка |
---|---|---|---|
UUID | Идентификатор версии записи о продукции в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор продукции в реестре Россельхознадзора. | bs:UUID | 1 |
Объект ..Response/productItem/subProduct
Объект содержит информацию о продукции. В данной операции возвращаются только идентификаторы.
Поле | Описание | Текст заголовка | Текст заголовка |
---|---|---|---|
UUID | Идентификатор версии записи о виде продукции в реестре Россельхознадзора. | bs:UUID | 1 |
GUID | Глобальный идентификатор вида продукции в реестре Россельхознадзора. | 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:getProductItemByGuidRequest>
<base:uuid>uuid</base:uuid>
</ws:getProductItemByGuidRequest>
</soapenv:Body>
</soapenv:Envelope>