GetSubProductByProductList
Перейти к навигации
Перейти к поиску
Общие сведения
Операция GetSubProductByProductList предназначена для получения списка видов продукции, отфильтрованного по указанному продукту. В список попадают только актуальные последние записи (active=true, last=true). Метод поддерживает возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка видов продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Используемые пространства имён и типы
|
|
|
Данные запроса
Объект getSubProductByProductListRequest
Корневой объект запроса.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
listOptions | Параметры запрашиваемого списка. | bs:ListOptions | 0..1 |
productGuid | Глобальный идентифкатор продукции, по которому производится отбор. | bs:UUID | 1 |
Объект ..Request/listOptions
Объект содержит параметры запрашиваемого списка продукции.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
count | Количество значений в списке.
|
xs:nonNegativeInteger | 0..1 |
offset | Смещение в списке относительно начала. | xs:nonNegativeInteger | 0..1 |
Данные ответа
Объект getSubProductByProductListResponse
Корневой элемент ответа.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
subProductList | Список видов продукции указанной в запросе. | prod:SubProductList | 1 |
Объект ..Response/subProductList
Список продукции, полученной в результате запроса.
Поле | Описание | Тип данных | Обязательность |
---|---|---|---|
subProduct | Данные о продукции. | prod:SubProduct | 0..* |
Объект ..Response/subProductList/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 |
name | Название вида продукции. | xs:string | 1 |
code | Код ТН ВЭД вида продукции. | xs:string | 1 |
englishName | Английское название вида продукции. | bs:String255 | 0..1 |
productGuid | Идентификатор продукции (второй уровень иерархии справочника продукции). | bs:UUID | 1 |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос данных 3 видов продукции со смещением 2 от начала списка.
<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"
xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production">
<soapenv:Header/>
<soapenv:Body>
<ws:getSubProductByProductListRequest>
<base:listOptions>
<base:count>3</base:count>
<base:offset>2</base:offset>
</base:listOptions>
<prod:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</prod:productGuid>
</ws:getSubProductByProductListRequest>
</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:getSubProductByProductListResponse 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:subProductList count="3" total="23" offset="2">
<pro: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>
<pro:name>курица домашняя: "части тушек обваленные, охлажденные"</pro:name>
<pro:code>0207131</pro:code>
<pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
</pro:subProduct>
<pro:subProduct>
<bs:uuid>f73981a2-7c2c-d412-8e89-b3be6a1c15e1</bs:uuid>
<bs:guid>23175390-cfa2-94a4-8eac-6237f4a47385</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>
<pro:name>курица домашняя: "части тушек необваленные, охлажденные"</pro:name>
<pro:code>0207132-0207137</pro:code>
<pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
</pro:subProduct>
<pro:subProduct>
<bs:uuid>ca4a9f4d-3845-4194-d4b6-07f3d8e6f3e0</bs:uuid>
<bs:guid>4c7ee80b-d421-5239-7d98-a764707b81f8</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>
<pro:name>курица домашняя: "части тушек обваленные мороженые"</pro:name>
<pro:code>0207141</pro:code>
<pro:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</pro:productGuid>
</pro:subProduct>
</pro:subProductList>
</ws:getSubProductByProductListResponse>
</S:Body>
</soapenv:Envelope>