GetR13nConditionList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetR13nConditionList''' предназначена для получения списка условий пе…») |
|||
| Строка 29: | Строка 29: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getR13nConditionListRequest> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|2 | |||
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions> | |||
|[[ListOptions|bs:ListOptions]] | |||
|[0..1] | |||
|Параметры запрашиваемого списка. | |||
|style="font-family: Courier;" | | |||
|- | |||
|3 | |||
|style="font-weight: bold; font-family: Courier;" |······<bs:count> | |||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |||
|[0..1] | |||
|Максимальное запрашиваемое количество объектов в списке. | |||
* По умолчанию значение 100; | |||
* Максимально возможное значение 1000. | |||
|style="font-family: Courier;" | | |||
|- | |||
|4 | |||
|style="font-weight: bold; font-family: Courier;" |······<bs:offset> | |||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |||
|[0..1] | |||
|Номер элемента, по которому осуществляется смещение первого элемента списка. | |||
* По умолчанию значение 0. | |||
|style="font-family: Courier;" | | |||
|- | |||
|5 | |||
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|6 | |||
|style="font-weight: bold; font-family: Courier;" |···<dt:disease> | |||
|[[AnimalDisease_v2.0|dt:AnimalDisease]] | |||
|[0..1] | |||
|(Опционально) Заболевание, к которому относятся запрашиваемые условия перемещения груза. | |||
|style="font-family: Courier;" | | |||
|- | |||
|7 | |||
|style="font-weight: bold; font-family: Courier;" |······<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Идентификатор заболевания. | |||
|style="font-family: Courier;" | | |||
|- | |||
|8 | |||
|style="font-weight: bold; font-family: Courier;" |······<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Глобальный идентификатор заболевания. | |||
|style="font-family: Courier;" | | |||
|- | |||
|9 | |||
|style="font-weight: bold; font-family: Courier;" |······<dt:name> | |||
|[[String255|bs:String255]] | |||
|[0..1] | |||
|Название заболевания. | |||
|style="font-family: Courier;" | | |||
|- | |||
|10 | |||
|style="font-weight: bold; font-family: Courier;" |···</dt:disease> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|11 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getR13nConditionListRequest> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Спецификация ответа== | ==Спецификация ответа== | ||
Версия 16:54, 30 октября 2017
Общие сведения
Операция GetR13nConditionList предназначена для получения списка условий перемещения грузов по правилам регионализации. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка наименований продукции, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
Выходные данные
- список условий перемещения грузов.
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getR13nConditionListRequest> | ||||
| 2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
| 3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
|
| 4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
|
| 5 | ···</bs:listOptions> | ||||
| 6 | ···<dt:disease> | dt:AnimalDisease | [0..1] | (Опционально) Заболевание, к которому относятся запрашиваемые условия перемещения груза. | |
| 7 | ······<bs:uuid> | bs:UUID | [0..1] | Идентификатор заболевания. | |
| 8 | ······<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор заболевания. | |
| 9 | ······<dt:name> | bs:String255 | [0..1] | Название заболевания. | |
| 10 | ···</dt:disease> | ||||
| 11 | </ws:getR13nConditionListRequest> |
Спецификация ответа
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Получение списка условий перемещения грузов по правилам регионализации. Вывод первых трёх записей без смещения.
Ответ на запрос.
