GetProductByTypeList v2.0
Перейти к навигации
Перейти к поиску
Версия для печати больше не поддерживается и может содержать ошибки обработки. Обновите закладки браузера и используйте вместо этого функцию печати браузера по умолчанию.
Общие сведения
Операция GetProductByTypeList предназначена для получения списка продукции по указанному типу. Тип продукции указан номером, посмотреть его можно здесь. Выполнение операции заканчивается либо возвратом списка продукции(active = true, last = true), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- тип продукции (1 уровень иерархического справочника).
Выходные данные
- список продукции (2 уровень иерархического справочника).
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getProductByTypeListRequest> | |||
| 002 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. |
| 003 | ······<bs:count>10</bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
| 004 | ······<bs:offset>2</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
| 005 | ···</bs:listOptions> | |||
| 006 | ···<dt:productType>5</dt:productType> | dt:ProductType | [1..1] | Тип продукции.
|
| 007 | </ws:getProductByTypeListRequest> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getProductByTypeListResponse> | |||
| 002 | ···<dt:productList total="2" offset="0" count="2"> | dt:ProductList | [1..1] | Список продукции.
|
| 003 | ······<dt:product> | dt:Product | [0..*] | Продукция.
|
| 004 | ·········<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии продукции. |
| 005 | ·········<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор продукции. |
| 006 | ·········<bs:active>true</bs:active> | xs:boolean | [1..1] | Описывает, является ли запись активной.
|
| 007 | ·········<bs:last>true</bs:last> | xs:boolean | [1..1] | Описывает, является ли версия записи последней.
|
| 008 | ·········<bs:status>100</bs:status> | bs:VersionStatus | [1..1] | Статус версии записи. |
| 009 | ·········<bs:createDate>2017-07-07T12:00:00</bs:createDate> | xs:DateTime | [1..1] | Дата создания записи. |
| 010 | ·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | xs:DateTime | [1..1] | Дата изменения записи. |
| 011 | ·········<bs:previous>UUID</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи. |
| 012 | ·········<dt:name>готовые мясные продукты</dt:name> | bs:String255 | [1..1] | Название продукции. |
| 013 | ·········<dt:code>0210, 1601, 1602</dt:code> | bs:String255 | [1..1] | Код ТН ВЭД продукции. |
| 014 | ·········<dt:productType>5</dt:productType> | dt:ProductType | [1..1] | Тип продукции.
|
| 015 | ······</dt:product> | |||
| 016 | ···</dt:productList> | |||
| 017 | </ws:getProductByTypeListResponse> |
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трёх элементов списка "Пищевые продукты" без смещения.
<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" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
<soapenv:Header/>
<soapenv:Body>
<ws:getProductByTypeListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
<dt:productType>5</dt:productType>
</ws:getProductByTypeListRequest>
</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:getProductByTypeListResponse 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:productList count="3" total="22" offset="0">
<dt: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+04:00</bs:createDate>
<bs:updateDate>2011-05-23T10:35:08+04:00</bs:updateDate>
<dt:name>готовые мясные продукты</dt:name>
<dt:code>0210, 1601, 1602</dt:code>
<dt:productType>5</dt:productType>
</dt:product>
<dt:product>
<bs:uuid>31c94ff1-a217-f38d-6005-1aa5ca67e146</bs:uuid>
<bs:guid>d34504bb-7a93-e1c8-4859-339eafd97c6c</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2011-05-23T10:49:01+04:00</bs:createDate>
<bs:updateDate>2011-05-23T10:49:01+04:00</bs:updateDate>
<dt:name>молоко и молочная продукция</dt:name>
<dt:code>0401-0406,1905,1517</dt:code>
<dt:productType>5</dt:productType>
</dt:product>
<dt:product>
<bs:uuid>84128278-7db4-1e11-da35-4ac7128569c6</bs:uuid>
<bs:guid>5f157caa-8f3b-4666-d3b0-5df86f8afb66</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2011-05-23T10:51:18+04:00</bs:createDate>
<bs:updateDate>2011-05-23T10:51:18+04:00</bs:updateDate>
<dt:name>яйца и продукты их переработки</dt:name>
<dt:code>0407,0408,2103,2106,3502</dt:code>
<dt:productType>5</dt:productType>
</dt:product>
</dt:productList>
</v2:getProductByTypeListResponse>
</soap:Body>
</soapenv:Envelope>
