GetActualR13nRegionStatusList v2.0

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

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

Операция 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>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getActualR13nRegionStatusListResponse>
2 ···<dt:r13nRegionStatusList count="4" total="4" offset="0"> dt:RegionalizationRegionStatusList [1..1] Список статусов региона:
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
3 ······<dt:status> dt:RegionalizationRegionStatus [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] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
7 ·········<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
8 ·········<bs:status> bs:VersionStatus [1..1] Статус версии записи. <bs:status>100</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>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
12 ·········<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
13 ·········<dt:referenceNumber> bs:Identifier [0..1] Номер статуса региона в реестре. <dt:referenceNumber>12</dt:referenceNumber>
14 ·········<dt:r13nZone> dt:Area [0..1] Регион, по которому запрашивались статусы.
15 ············<dt:country> dt:Country [1..1] Страна
16 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
17 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
18 ···············<dt:name> bs:String255 [1..1] Наименование страны. <dt:name>Российская Федерация</dt:name>
19 ············</dt:country>
20 ············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
21 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
22 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
23 ···············<dt:name> bs:String255 [1..1] Наименование региона страны. <dt:name>Владимирская область</dt:name>
24 ············</dt:region>
25 ············<dt:district> dt:District [0..1] Район региона
26 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
27 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
28 ···············<dt:name> bs:String255 [1..1] Наименование района региона. <dt:name>Собинский район</dt:name>
29 ············</dt:district>
30 ············<dt:locality> dt:Locality [0..1] Населённый пункт
31 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
32 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
33 ···············<dt:name> bs:String255 [1..1] Наименование насленного пункта. <dt:name>Владимир г</dt:name>
34 ············</dt:locality>
35 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
36 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
37 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
38 ···············<dt:name> bs:String255 [1..1] Наименование населенного пункта. <dt:name>Энергетик пос</dt:name>
39 ············</dt:subLocality>
40 ············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл.</dt:addressView>
41 ·········</dt:r13nZone>
42 ·········<dt:excludedR13nZone> dt:Area [0..*] Территория/регион внутри `r13Zone` с отличным (другим) статусом регионализации.
43 ············<dt:country> dt:Country [1..1] Страна
44 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
45 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор страны. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
46 ···············<dt:name> bs:String255 [1..1] Наименование страны. <dt:name>Российская Федерация</dt:name>
47 ············</dt:country>
48 ············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
49 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны. <bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid>
50 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны. <bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid>
51 ···············<dt:name> bs:String255 [1..1] Наименование региона страны. <dt:name>Владимирская область</dt:name>
52 ············</dt:region>
53 ············<dt:district> dt:District [0..1] Район региона
54 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона. <bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid>
55 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона. <bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid>
56 ···············<dt:name> bs:String255 [1..1] Наименование района региона. <dt:name>Собинский район</dt:name>
57 ············</dt:district>
58 ············<dt:locality> dt:Locality [0..1] Населённый пункт
59 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта. <bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid>
60 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта. <bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid>
61 ···············<dt:name> bs:String255 [1..1] Наименование насленного пункта. <dt:name>Владимир г</dt:name>
62 ············</dt:locality>
63 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
64 ···············<bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта. <bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid>
65 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта. <bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid>
66 ···············<dt:name> bs:String255 [1..1] Наименование населенного пункта. <dt:name>Энергетик пос</dt:name>
67 ············</dt:subLocality>
68 ············<dt:addressView> bs:String255 [0..1] Строковое представление адреса. <dt:addressView>Российская Федерация, Владимирская обл.</dt:addressView>
69 ·········</dt:excludedR13nZone>
70 ·········<dt:r13nStatus> dt:RegionalizationStatus [0..*] Статус регионализации
71 ············<dt:relatedDisease> dt:AnimalDisease [1..1] Заболевание, по которому назначен статус
72 ···············<bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
73 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
74 ···············<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
75 ···············<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
76 ···············<bs:status> bs:VersionStatus [1..1] Статус версии заболевания. <bs:status>100</bs:status>
77 ···············<bs:createDate> xs:DateTime [1..1] Дата создания заболевания. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
78 ···············<bs:updateDate> xs:DateTime [1..1] Дата изменения заболевания. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
79 ···············<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра заболевания. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
80 ···············<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра заболевания. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
81 ···············<dt:name> bs:String255 [1..1] Наименование заболевания <dt:name>Ящур</dt:name>
82 ············</dt:relatedDisease>
83 ············<dt:prosperity> dt:ProsperityType [1..1] Статус благополучия:
  • UNDEFINED - не определялся
  • UNKNOWN - неизвестный
  • SAFE - благополучный
  • UNSAFE - неблагополучный
 <dt:prosperity>UNSAFE</dt:prosperity>
84 ············<dt:vaccination> dt:VaccinationType [1..1] Статус применения вакцины:
  • UNDEFINED - неопределенный
  • APPLIED - вакцинация проводится
  • UNVACCINATED - вакцинация не проводится
 <dt:vaccination>APPLIED</dt:vaccination>
85 ·········</dt:r13nStatus>
86 ······</dt:status>
87 ···</dt:r13nRegionStatusList>
88 </ws:getActualR13nRegionStatusListResponse>

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

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

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

Получение списка статусов регионализации Ростовской области по болезни "Грипп птиц". 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getActualR13nRegionStatusListRequest>
         <dt:disease>
             <bs:guid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:guid>
         </dt:disease>
         <dt:r13nZone>
            <dt:region>
               <bs:guid>f10763dc-63e3-48db-83e1-9c566fe3092b</bs:guid>
            </dt:region>
         </dt:r13nZone>
      </ws:getActualR13nRegionStatusListRequest>
   </soapenv:Body>
</soapenv:Envelope>



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