GetActualR13nRegionStatusList v2.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetActualR13nRegionStatusList''' предназначена для получения списка стату…»)
 
Строка 31: Строка 31:


==Спецификация запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание
! Пример
|-
|1
|style="font-weight: bold; font-family: Courier;" |<ws:getActualR13nRegionStatusListRequest>
|
|
|
|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;" |···&lt;dt:disease>
|[[AnimalDisease_v2.0|dt:AnimalDisease]]
|[1..1]
|Заболевание, к которому относятся запрашиваемые условия перемещения груза.
|style="font-family: Courier;" |
|-
|7
|style="font-weight: bold; font-family: Courier;" |······<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор заболевания.
|style="font-family: Courier;" |
|-
|8
|style="font-weight: bold; font-family: Courier;" |···</dt:disease>
|
|
|
|style="font-family: Courier;" |
|-
|9
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:r13nZone>
|[[Area_v2.0|dt:Area]]
|[0..1]
|(Опционально) Регион, по которому запрашиваются статусы.
|style="font-family: Courier;" |
|-
|10
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:country>
|[[Country_v2.0|dt:Country]]
|[0..1]
|Описание страны.
|style="font-family: Courier;" |
|-
|11
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор страны.
|style="font-family: Courier;" |
|-
|12
|style="font-weight: bold; font-family: Courier;" |······</dt:country>
|
|
|
|style="font-family: Courier;" |
|-
|13
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:region>
|[[Region_v2.0|dt:Region]]
|[0..1]
|Регион страны.
|style="font-family: Courier;" |
|-
|14
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор региона.
|style="font-family: Courier;" |
|-
|15
|style="font-weight: bold; font-family: Courier;" |······</dt:region>
|
|
|
|style="font-family: Courier;" |
|-
|16
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:district>
|[[District_v2.0|dt:District]]
|[0..1]
|Район региона.
|style="font-family: Courier;" |
|-
|17
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор района.
|style="font-family: Courier;" |
|-
|18
|style="font-weight: bold; font-family: Courier;" |······</dt:district>
|
|
|
|style="font-family: Courier;" |
|-
|19
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:locality>
|[[Locality_v2.0|dt:Locality]]
|[0..1]
|Населённый пункт.
|style="font-family: Courier;" |
|-
|20
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор населенного пункта.
|style="font-family: Courier;" |
|-
|21
|style="font-weight: bold; font-family: Courier;" |······</dt:locality>
|
|
|
|style="font-family: Courier;" |
|-
|22
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:subLocality>
|[[Locality_v2.0|dt:Locality]]
|[0..1]
|Населённый пункт, подчинённый населённому пункту.
|style="font-family: Courier;" |
|-
|23
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|[[UUID|bs:UUID]]
|[1..1]
|Глобальный идентификатор населенного пункта.
|style="font-family: Courier;" |
|-
|24
|style="font-weight: bold; font-family: Courier;" |······</dt:subLocality>
|
|
|
|style="font-family: Courier;" |
|-
|25
|style="font-weight: bold; font-family: Courier;" |···</dt:r13nZone>
|
|
|
|style="font-family: Courier;" |
|-
|26
|style="font-weight: bold; font-family: Courier;" |</ws:getActualR13nRegionStatusListRequest>
|
|
|
|style="font-family: Courier;" |
|-
|}


==Спецификация ответа==
==Спецификация ответа==

Версия 11:24, 31 октября 2017

Общие сведения

Операция GetActualR13nRegionStatusList предназначена для получения списка статусов регионов по правилам регионализации. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка статусов, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.

Входные данные

  • параметры выводимого списка;
  • глобальный идентификатор заболевания;
  • (опционально) регион, по которому запрашиваются статусы.

Выходные данные

  • список статусов регионов.

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getActualR13nRegionStatusListRequest>
2 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
3 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
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 Заданный в запросе отступ больше числа записей в результате запроса.

Пример запроса

Получение списка условий по конкретному заболеванию. Вывод первых трёх записей без смещения.


Ответ на запрос.


Источник — http://help.vetrf.ru/index.php?title=GetActualR13nRegionStatusList_v2.0&oldid=22399