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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 60: Строка 60:
* По умолчанию значение 100;
* По умолчанию значение 100;
* Максимально возможное значение 1000.
* Максимально возможное значение 1000.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:count>10</bs:count>
|-
|-
|4
|4
Строка 68: Строка 68:
|Номер элемента, по которому осуществляется смещение первого элемента списка.  
|Номер элемента, по которому осуществляется смещение первого элемента списка.  
* По умолчанию значение 0.
* По умолчанию значение 0.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
|-
|-
|5
|5
Строка 89: Строка 89:
|[1..1]
|[1..1]
|Глобальный идентификатор заболевания.
|Глобальный идентификатор заболевания.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid>
|-
|-
|8
|8
Строка 117: Строка 117:
|[1..1]
|[1..1]
|Глобальный идентификатор страны.
|Глобальный идентификатор страны.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid>
|-
|-
|12
|12
Строка 138: Строка 138:
|[1..1]
|[1..1]
|Глобальный идентификатор региона.
|Глобальный идентификатор региона.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:guid>0d4ab22b-0461-4ef1-a151-05162558d89c</bs:guid>
|-
|-
|15
|15
Строка 159: Строка 159:
|[1..1]
|[1..1]
|Глобальный идентификатор района.
|Глобальный идентификатор района.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:guid>c9862fa8-e7cb-4b01-a62f-eba8328a6a2c</bs:guid>
|-
|-
|18
|18
Строка 180: Строка 180:
|[1..1]
|[1..1]
|Глобальный идентификатор населенного пункта.
|Глобальный идентификатор населенного пункта.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
|-
|-
|21
|21
Строка 201: Строка 201:
|[1..1]
|[1..1]
|Глобальный идентификатор населенного пункта.
|Глобальный идентификатор населенного пункта.
|style="font-family: Courier;" |
|style="font-family: Courier;" |<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
|-
|-
|24
|24

Версия 11:25, 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.
<bs:count>10</bs:count>
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
<bs:offset>2</bs:offset>
5 ···</bs:listOptions>
6 ···<dt:disease> dt:AnimalDisease [1..1] Заболевание, к которому относятся запрашиваемые условия перемещения груза.
7 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания. <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid>
8 ···</dt:disease>
9 ···<dt:r13nZone> dt:Area [0..1] (Опционально) Регион, по которому запрашиваются статусы.
10 ······<dt:country> dt:Country [0..1] Описание страны.
11 ·········<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны. <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid>
12 ······</dt:country>
13 ······<dt:region> dt:Region [0..1] Регион страны.
14 ·········<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона. <bs:guid>0d4ab22b-0461-4ef1-a151-05162558d89c</bs:guid>
15 ······</dt:region>
16 ······<dt:district> dt:District [0..1] Район региона.
17 ·········<bs:guid> bs:UUID [1..1] Глобальный идентификатор района. <bs:guid>c9862fa8-e7cb-4b01-a62f-eba8328a6a2c</bs:guid>
18 ······</dt:district>
19 ······<dt:locality> dt:Locality [0..1] Населённый пункт.
20 ·········<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта. <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
21 ······</dt:locality>
22 ······<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчинённый населённому пункту.
23 ·········<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
24 ······</dt:subLocality>
25 ···</dt:r13nZone>
26 </ws:getActualR13nRegionStatusListRequest>

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

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

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

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


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