GetProductByTypeList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 92: | Строка 92: | ||
==Спецификация ответа== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getProductByTypeListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|2 | |||
|style="font-weight: bold; font-family: Courier;" |···<dt:productList count="19" total="19" offset="0"> | |||
|[[ProductList_v2.0|dt:ProductList]] | |||
|[1..1] | |||
|Список продукции | |||
* total - всего записей; | |||
* offset - смещение относительно первого элемента; | |||
* count - количество выводимых записей. | |||
|style="font-family: Courier;" | | |||
|- | |||
|3 | |||
|style="font-weight: bold; font-family: Courier;" |······<dt:product> | |||
|[[Product_v2.0|dt:Product]] | |||
|[0..*] | |||
|Продукция | |||
* второй уровень иерархического справочника продукции ИС Меркурий | |||
|style="font-family: Courier;" | | |||
|- | |||
|4 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Идентификатор версии продукции. | |||
|style="font-family: Courier;" |<bs:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</bs:uuid> | |||
|- | |||
|5 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор продукции. | |||
|style="font-family: Courier;" |<bs:guid>362aa885-9b9f-ae95-05d0-f9570f4fbdc6</bs:guid> | |||
|- | |||
|6 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:active> | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|Является ли запись активной: | |||
* true - запись активна; | |||
* false - запись не активна. | |||
|style="font-family: Courier;" |<bs:active>true</bs:active> | |||
|- | |||
|7 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:last> | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|Является ли версия записи последней: | |||
* true - да; | |||
* false - нет. | |||
|style="font-family: Courier;" |<bs:last>true</bs:last> | |||
|- | |||
|8 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:status> | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
|Статус версии записи. | |||
|style="font-family: Courier;" |<bs:status>100</bs:status> | |||
|- | |||
|9 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:createDate> | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
|Дата создания записи. | |||
|style="font-family: Courier;" |<bs:createDate>2017-07-07T12:00:00</bs:createDate> | |||
|- | |||
|10 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:updateDate> | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
|Дата изменения записи. | |||
|style="font-family: Courier;" |<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | |||
|- | |||
|11 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:previous> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Идентификатор предыдущей версии записи. | |||
|style="font-family: Courier;" |<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> | |||
|- | |||
|12 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:next> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Идентификатор следующей версии записи. | |||
|style="font-family: Courier;" |<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> | |||
|- | |||
|13 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Название продукции. | |||
|style="font-family: Courier;" |<dt:name>готовые мясные продукты</dt:name> | |||
|- | |||
|14 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:code> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Код ТН ВЭД продукции. | |||
|style="font-family: Courier;" |<dt:code>0210, 1601, 1602</dt:code> | |||
|- | |||
|15 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:productType> | |||
|[[ProductType_v2.0|dt:ProductType]] | |||
|[1..1] | |||
|Тип продукции | |||
* первый уровень иерархического справочника продукции ИС Меркурий | |||
|style="font-family: Courier;" |<dt:productType>5</dt:productType> | |||
|- | |||
|16 | |||
|style="font-weight: bold; font-family: Courier;" |······</dt:product> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|17 | |||
|style="font-weight: bold; font-family: Courier;" |···</dt:productList> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|18 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getProductByTypeListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Описание ошибок== | ==Описание ошибок== |
Версия 23:03, 29 октября 2017
Общие сведения
Операция GetProductByTypeList предназначена для получения списка продукции по указанному типу. Тип продукции указан номером, посмотреть его можно здесь. Выполнение операции заканчивается либо возвратом списка продукции(active = true, last = true), либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- тип продукции (1 уровень иерархического справочника).
Выходные данные
- список продукции (2 уровень иерархического справочника).
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getProductByTypeListRequest> | ||||
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> | ||||
2 | ···<dt:productType> | dt:ProductType | [1..1] | Тип продукции
|
<dt:productType>5</dt:productType> |
3 | </ws:getProductByTypeListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getProductByTypeListResponse> | ||||
2 | ···<dt:productList count="19" total="19" offset="0"> | dt:ProductList | [1..1] | Список продукции
|
|
3 | ······<dt:product> | dt:Product | [0..*] | Продукция
|
|
4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии продукции. | <bs:uuid>3008afa9-8a88-8586-5f75-08ce43189ac8</bs:uuid> |
5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор продукции. | <bs:guid>362aa885-9b9f-ae95-05d0-f9570f4fbdc6</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>0210, 1601, 1602</dt:code> |
15 | ·········<dt:productType> | dt:ProductType | [1..1] | Тип продукции
|
<dt:productType>5</dt:productType> |
16 | ······</dt:product> | ||||
17 | ···</dt:productList> | ||||
18 | </ws:getProductByTypeListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трёх элементов списка "Пищевые продукты" без смещения.
Ответ на запрос.