GetR13nConditionList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 106: | Строка 106: | ||
==Спецификация ответа== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getR13nConditionListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|2 | |||
|style="font-weight: bold; font-family: Courier;" |···<dt:r13nConditionList count="100" total="539" offset="0"> | |||
|[[RegionalizationConditionList_v2.0|dt:RegionalizationConditionList]] | |||
|[1..1] | |||
|Тип, описывающий список условий перемещения. | |||
* total - всего записей; | |||
* offset - смещение относительно первого элемента; | |||
* count - количество выводимых записей. | |||
|style="font-family: Courier;" | | |||
|- | |||
|3 | |||
|style="font-weight: bold; font-family: Courier;" |······<dt:condition> | |||
|[[RegionalizationCondition_v2.0|dt:RegionalizationCondition]] | |||
|[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>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> | |||
|- | |||
|5 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор условия регионализации. | |||
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</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></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>7c78bf3f-c1e8-496b-a5c1-173af60e95e4</bs:previous> | |||
|- | |||
|12 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:next> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Идентификатор следующей версии условия регионализации. | |||
|style="font-family: Courier;" |<bs:next>82c7af0d-7067-4a67-8a53-39f4a5bcd700</bs:next> | |||
|- | |||
|13 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:referenceNumber> | |||
|[[Identifier|bs:Identifier]] | |||
|[0..1] | |||
|Номер условия. | |||
|style="font-family: Courier;" |<dt:referenceNumber>6</dt:referenceNumber> | |||
|- | |||
|14 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:text> | |||
|[[Text|bs:Text]] | |||
|[0..1] | |||
|Формулировка условия. | |||
|style="font-family: Courier;" |<dt:text>Свиньи должны быть подвергнуты клиническому освидетельствованию в день отправки и при этом не иметь клинических признаков АЧС</dt:text> | |||
|- | |||
|15 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:strict> | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[0..1] | |||
|Обязательность соблюдения условия. | |||
|style="font-family: Courier;" |<dt:strict>true</dt:strict> | |||
|- | |||
|16 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:relatedDisease> | |||
|[[AnimalDisease_v2.0|dt:AnimalDisease]] | |||
|[0..*] | |||
|Заболевание, к которому относится данное условие. | |||
|style="font-family: Courier;" | | |||
|- | |||
|17 | |||
|style="font-weight: bold; font-family: Courier;" |············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Идентификатор версии заболевания. | |||
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> | |||
|- | |||
|18 | |||
|style="font-weight: bold; font-family: Courier;" |············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор заболевания. | |||
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid> | |||
|- | |||
|19 | |||
|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> | |||
|- | |||
|20 | |||
|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> | |||
|- | |||
|21 | |||
|style="font-weight: bold; font-family: Courier;" |············<bs:status> | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
|Статус версии заболевания. | |||
|style="font-family: Courier;" |<bs:status>100</bs:status> | |||
|- | |||
|22 | |||
|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> | |||
|- | |||
|23 | |||
|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> | |||
|- | |||
|24 | |||
|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> | |||
|- | |||
|25 | |||
|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> | |||
|- | |||
|26 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование заболевания | |||
|style="font-family: Courier;" |<dt:name>Ящур</dt:name> | |||
|- | |||
|27 | |||
|style="font-weight: bold; font-family: Courier;" |·········</dt:relatedDisease> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|28 | |||
|style="font-weight: bold; font-family: Courier;" |······</dt:condition> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|29 | |||
|style="font-weight: bold; font-family: Courier;" |···</dt:r13nConditionList> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|30 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getR13nConditionListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Описание ошибок== | ==Описание ошибок== |
Версия 16:57, 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:guid> | bs:UUID | [1..1] | Глобальный идентификатор заболевания. | |
8 | ···</dt:disease> | ||||
9 | </ws:getR13nConditionListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getR13nConditionListResponse> | ||||
2 | ···<dt:r13nConditionList count="100" total="539" offset="0"> | dt:RegionalizationConditionList | [1..1] | Тип, описывающий список условий перемещения.
|
|
3 | ······<dt:condition> | dt:RegionalizationCondition | [0..*] | Условие регионализации, соблюдаемое при перевозке груза | |
4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии условия регионализации. | <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> |
5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор условия регионализации. | <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</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></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>7c78bf3f-c1e8-496b-a5c1-173af60e95e4</bs:previous> |
12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии условия регионализации. | <bs:next>82c7af0d-7067-4a67-8a53-39f4a5bcd700</bs:next> |
13 | ·········<bs:referenceNumber> | bs:Identifier | [0..1] | Номер условия. | <dt:referenceNumber>6</dt:referenceNumber> |
14 | ·········<bs:text> | bs:Text | [0..1] | Формулировка условия. | <dt:text>Свиньи должны быть подвергнуты клиническому освидетельствованию в день отправки и при этом не иметь клинических признаков АЧС</dt:text> |
15 | ·········<bs:strict> | xs:boolean | [0..1] | Обязательность соблюдения условия. | <dt:strict>true</dt:strict> |
16 | ·········<dt:relatedDisease> | dt:AnimalDisease | [0..*] | Заболевание, к которому относится данное условие. | |
17 | ············<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии заболевания. | <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> |
18 | ············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор заболевания. | <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid> |
19 | ············<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
20 | ············<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
21 | ············<bs:status> | bs:VersionStatus | [1..1] | Статус версии заболевания. | <bs:status>100</bs:status> |
22 | ············<bs:createDate> | xs:DateTime | [1..1] | Дата создания заболевания. | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
23 | ············<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения заболевания. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
24 | ············<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи реестра заболевания. | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
25 | ············<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи реестра заболевания. | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
26 | ············<dt:name> | bs:String255 | [1..1] | Наименование заболевания | <dt:name>Ящур</dt:name> |
27 | ·········</dt:relatedDisease> | ||||
28 | ······</dt:condition> | ||||
29 | ···</dt:r13nConditionList> | ||||
30 | </ws:getR13nConditionListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Получение списка условий перемещения грузов по правилам регионализации. Вывод первых трёх записей без смещения.
Ответ на запрос.