GetSubProductByProductList v2.0
Общие сведения
Операция GetSubProductByProductList предназначена для получения списка видов продукции (3 уровень иерархического справочника), отфильтрованного по указанному продукту (2 уровень иерархического справочника). В список попадают только актуальные последние записи (active=true, last=true). Метод поддерживает возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка видов продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка.
- идентификатор продукта (2 уровень иерархического справочника)
Выходные данные
- данные запрошенного вида продукции (3 уровень иерархического справочника).
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getSubProductByProductListRequest> | ||||
| 2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
| 3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
| 4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<bs:offset>2</bs:offset> |
| 5 | ···</bs:listOptions> | ||||
| 6 | ···<dt:productGuid | bs:UUID | [1..1] | Глобальный идентификатор продукции
|
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid> |
| 7 | </ws:getSubProductByProductListRequest> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getSubProductByProductListResponse> | ||||
| 2 | ···<dt:subProductList count="23" total="23" offset="0"> | dt:SubProductList | [1..1] | Список видов продукции
|
|
| 3 | ······<dt:subProduct> | dt:SubProduct | [0..*] | Вид продукции
|
|
| 4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии вида продукции. | <bs:uuid>d9078e32-353c-eb56-3839-9bc09e79bdf5</bs:uuid> |
| 5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор вида продукции. | <bs:guid>bb7ab7a7-4d5c-f81d-50a9-da5bf9bbb1e9</bs:guid> |
| 6 | ·········<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
| 7 | ·········<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
| 8 | ·········<bs:status> | bs:VersionStatus | [1..1] | Статус версии записи. | <bs:status>100</bs:status> |
| 9 | ·········<bs:createDate> | xs:DateTime | [1..1] | Дата создания записи. | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
| 10 | ·········<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения записи. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
| 11 | ·········<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи. | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
| 12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи. | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
| 13 | ·········<dt:name> | bs:String255 | [1..1] | Название вида продукции. | <dt:name>мясо птицы</dt:name> |
| 14 | ·········<dt:code> | bs:String255 | [1..1] | Код ТН ВЭД вида продукции. | <dt:code>0207</dt:code> |
| 15 | ·········<dt:productGuid | bs:UUID | [1..1] | Глобальный идентификатор продукции
|
<dt:productGuid>337f79dc-4376-6e33-dabe-d5447913b97d</dt:productGuid> |
| 16 | ······</dt:subProduct> | ||||
| 17 | ···</dt:subProductList> | ||||
| 18 | </ws:getSubProductByProductListResponse> |
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос данных 3 видов продукции со смещением 2 от начала списка.
Ответ на запрос.
