GetActualR13nRegionStatusList v2.0
Общие сведения
Операция GetActualR13nRegionStatusList предназначена для получения списка статусов регионов по правилам регионализации. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка статусов, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- глобальный идентификатор заболевания;
- (опционально) регион, по которому запрашиваются статусы.
Выходные данные
- список статусов регионов.
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getActualR13nRegionStatusListRequest> | ||||
| 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 | [1..1] | Заболевание, к которому относятся запрашиваемые условия перемещения груза. | |
| 7 | ······<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор заболевания. | |
| 8 | ···</dt:disease> | ||||
| 9 | ···<dt:r13nZone> | dt:Area | [0..1] | (Опционально) Регион, по которому запрашиваются статусы. | |
| 10 | ······<dt:country> | dt:Country | [0..1] | Описание страны. | |
| 11 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор страны. | |
| 12 | ······</dt:country> | ||||
| 13 | ······<dt:region> | dt:Region | [0..1] | Регион страны. | |
| 14 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор региона. | |
| 15 | ······</dt:region> | ||||
| 16 | ······<dt:district> | dt:District | [0..1] | Район региона. | |
| 17 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор района. | |
| 18 | ······</dt:district> | ||||
| 19 | ······<dt:locality> | dt:Locality | [0..1] | Населённый пункт. | |
| 20 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор населенного пункта. | |
| 21 | ······</dt:locality> | ||||
| 22 | ······<dt:subLocality> | dt:Locality | [0..1] | Населённый пункт, подчинённый населённому пункту. | |
| 23 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор населенного пункта. | |
| 24 | ······</dt:subLocality> | ||||
| 25 | ···</dt:r13nZone> | ||||
| 26 | </ws:getActualR13nRegionStatusListRequest> |
Спецификация ответа
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Получение списка условий по конкретному заболеванию. Вывод первых трёх записей без смещения.
Ответ на запрос.
