GetActualR13nRegionStatusList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(не показаны 4 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
==Общие сведения== | ==Общие сведения== | ||
Операция '''GetActualR13nRegionStatusList''' предназначена для получения списка статусов регионов по | Операция '''GetActualR13nRegionStatusList''' предназначена для получения списка статусов регионов по конкретному заболеванию. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка статусов, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса. | ||
<!--===Используемые пространства имён и типы=== | <!--===Используемые пространства имён и типы=== | ||
Строка 227: | Строка 227: | ||
==Спецификация ответа== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getActualR13nRegionStatusListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|2 | |||
|style="font-weight: bold; font-family: Courier;" |···<dt:r13nRegionStatusList count="4" total="4" offset="0"> | |||
|[[RegionalizationRegionStatusList_v2.0|dt:RegionalizationRegionStatusList]] | |||
|[1..1] | |||
|Список статусов региона: | |||
* total - всего записей; | |||
* offset - смещение относительно первого элемента; | |||
* count - количество выводимых записей. | |||
|style="font-family: Courier;" | | |||
|- | |||
|3 | |||
|style="font-weight: bold; font-family: Courier;" |······<dt:status> | |||
|[[RegionalizationRegionStatus_v2.0|dt:RegionalizationRegionStatus]] | |||
|[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>100</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>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> | |||
|- | |||
|12 | |||
|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> | |||
|- | |||
|13 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:referenceNumber> | |||
|[[Identifier|bs:Identifier]] | |||
|[0..1] | |||
|Номер статуса региона в реестре. | |||
|style="font-family: Courier;" |<dt:referenceNumber>12</dt:referenceNumber> | |||
|- | |||
|14 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:r13nZone> | |||
|[[Area_v2.0|dt:Area]] | |||
|[0..1] | |||
|Регион, по которому запрашивались статусы. | |||
|style="font-family: Courier;" | | |||
|- | |||
|15 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:country> | |||
|[[Country_v2.0|dt:Country]] | |||
|[1..1] | |||
|Страна | |||
|style="font-family: Courier;" | | |||
|- | |||
|16 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор страны. | |||
|style="font-family: Courier;" |<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid> | |||
|- | |||
|17 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор страны. | |||
|style="font-family: Courier;" |<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid> | |||
|- | |||
|18 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование страны. | |||
|style="font-family: Courier;" |<dt:name>Российская Федерация</dt:name> | |||
|- | |||
|19 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:country> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|20 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:region> | |||
|[[Region_v2.0|dt:Region]] | |||
|[1..1] | |||
|Регион (республика, область, край, автономная область) | |||
|style="font-family: Courier;" | | |||
|- | |||
|21 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор региона страны. | |||
|style="font-family: Courier;" |<bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid> | |||
|- | |||
|22 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор региона страны. | |||
|style="font-family: Courier;" |<bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid> | |||
|- | |||
|23 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование региона страны. | |||
|style="font-family: Courier;" |<dt:name>Владимирская область</dt:name> | |||
|- | |||
|24 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:region> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|25 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:district> | |||
|[[District_v2.0|dt:District]] | |||
|[0..1] | |||
|Район региона | |||
|style="font-family: Courier;" | | |||
|- | |||
|26 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор района региона. | |||
|style="font-family: Courier;" |<bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid> | |||
|- | |||
|27 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор района региона. | |||
|style="font-family: Courier;" |<bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid> | |||
|- | |||
|28 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование района региона. | |||
|style="font-family: Courier;" |<dt:name>Собинский район</dt:name> | |||
|- | |||
|29 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:district> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|30 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:locality> | |||
|[[Locality_v2.0|dt:Locality]] | |||
|[0..1] | |||
|Населённый пункт | |||
|style="font-family: Courier;" | | |||
|- | |||
|31 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid> | |||
|- | |||
|32 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid> | |||
|- | |||
|33 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование насленного пункта. | |||
|style="font-family: Courier;" |<dt:name>Владимир г</dt:name> | |||
|- | |||
|34 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:locality> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|35 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:subLocality> | |||
|[[Locality_v2.0|dt:Locality]] | |||
|[0..1] | |||
|Населённый пункт, подчиненный другогому населенному пункту (locality) | |||
|style="font-family: Courier;" | | |||
|- | |||
|36 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid> | |||
|- | |||
|37 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid> | |||
|- | |||
|38 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование населенного пункта. | |||
|style="font-family: Courier;" |<dt:name>Энергетик пос</dt:name> | |||
|- | |||
|39 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:subLocality> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|40 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:addressView> | |||
|[[String255|bs:String255]] | |||
|[0..1] | |||
|Строковое представление адреса. | |||
|style="font-family: Courier;" |<dt:addressView>Российская Федерация, Владимирская обл.</dt:addressView> | |||
|- | |||
|41 | |||
|style="font-weight: bold; font-family: Courier;" |·········</dt:r13nZone> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|42 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:excludedR13nZone> | |||
|[[Area_v2.0|dt:Area]] | |||
|[0..*] | |||
|Территория/регион внутри `r13Zone` с отличным (другим) статусом регионализации. | |||
|style="font-family: Courier;" | | |||
|- | |||
|43 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:country> | |||
|[[Country_v2.0|dt:Country]] | |||
|[1..1] | |||
|Страна | |||
|style="font-family: Courier;" | | |||
|- | |||
|44 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор страны. | |||
|style="font-family: Courier;" |<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid> | |||
|- | |||
|45 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор страны. | |||
|style="font-family: Courier;" |<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid> | |||
|- | |||
|46 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование страны. | |||
|style="font-family: Courier;" |<dt:name>Российская Федерация</dt:name> | |||
|- | |||
|47 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:country> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|48 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:region> | |||
|[[Region_v2.0|dt:Region]] | |||
|[1..1] | |||
|Регион (республика, область, край, автономная область) | |||
|style="font-family: Courier;" | | |||
|- | |||
|49 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор региона страны. | |||
|style="font-family: Courier;" |<bs:uuid>e440dcdb-31d6-39a4-db63-a1c0731d61d6</bs:uuid> | |||
|- | |||
|50 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор региона страны. | |||
|style="font-family: Courier;" |<bs:guid>cbdf8cb6-fb9a-4f36-36d3-04488f6d1b82</bs:guid> | |||
|- | |||
|51 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование региона страны. | |||
|style="font-family: Courier;" |<dt:name>Владимирская область</dt:name> | |||
|- | |||
|52 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:region> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|53 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:district> | |||
|[[District_v2.0|dt:District]] | |||
|[0..1] | |||
|Район региона | |||
|style="font-family: Courier;" | | |||
|- | |||
|54 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор района региона. | |||
|style="font-family: Courier;" |<bs:uuid>3cb373d5-32f1-ac2a-754c-58d4b33825dd</bs:uuid> | |||
|- | |||
|55 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор района региона. | |||
|style="font-family: Courier;" |<bs:guid>90d82878-431a-0cf1-0974-16d4fdff3bc8</bs:guid> | |||
|- | |||
|56 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование района региона. | |||
|style="font-family: Courier;" |<dt:name>Собинский район</dt:name> | |||
|- | |||
|57 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:district> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|58 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:locality> | |||
|[[Locality_v2.0|dt:Locality]] | |||
|[0..1] | |||
|Населённый пункт | |||
|style="font-family: Courier;" | | |||
|- | |||
|59 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:uuid>70db962b-d3f3-9a13-93d1-f83a9bc6ed80</bs:uuid> | |||
|- | |||
|60 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:guid>a16545f3-8f9c-2778-099f-a5d302e58712</bs:guid> | |||
|- | |||
|61 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование насленного пункта. | |||
|style="font-family: Courier;" |<dt:name>Владимир г</dt:name> | |||
|- | |||
|62 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:locality> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|63 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:subLocality> | |||
|[[Locality_v2.0|dt:Locality]] | |||
|[0..1] | |||
|Населённый пункт, подчиненный другогому населенному пункту (locality) | |||
|style="font-family: Courier;" | | |||
|- | |||
|64 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Уникальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:uuid>3a7b2d0c-2ebd-0dff-9e93-341097ee1db3</bs:uuid> | |||
|- | |||
|65 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор населенного пункта. | |||
|style="font-family: Courier;" |<bs:guid>9f315346-b470-3a1c-56d0-ae1afe9579df</bs:guid> | |||
|- | |||
|66 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование населенного пункта. | |||
|style="font-family: Courier;" |<dt:name>Энергетик пос</dt:name> | |||
|- | |||
|67 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:subLocality> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|68 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:addressView> | |||
|[[String255|bs:String255]] | |||
|[0..1] | |||
|Строковое представление адреса. | |||
|style="font-family: Courier;" |<dt:addressView>Российская Федерация, Владимирская обл.</dt:addressView> | |||
|- | |||
|69 | |||
|style="font-weight: bold; font-family: Courier;" |·········</dt:excludedR13nZone> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|70 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:r13nStatus> | |||
|[[RegionalizationStatus_v2.0|dt:RegionalizationStatus]] | |||
|[0..*] | |||
|Статус регионализации | |||
|style="font-family: Courier;" | | |||
|- | |||
|71 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:relatedDisease> | |||
|[[AnimalDisease_v2.0|dt:AnimalDisease]] | |||
|[1..1] | |||
|Заболевание, по которому назначен статус | |||
|style="font-family: Courier;" | | |||
|- | |||
|72 | |||
|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> | |||
|- | |||
|73 | |||
|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> | |||
|- | |||
|74 | |||
|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> | |||
|- | |||
|75 | |||
|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> | |||
|- | |||
|76 | |||
|style="font-weight: bold; font-family: Courier;" |···············<bs:status> | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
|Статус версии заболевания. | |||
|style="font-family: Courier;" |<bs:status>100</bs:status> | |||
|- | |||
|77 | |||
|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> | |||
|- | |||
|78 | |||
|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> | |||
|- | |||
|79 | |||
|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> | |||
|- | |||
|80 | |||
|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> | |||
|- | |||
|81 | |||
|style="font-weight: bold; font-family: Courier;" |···············<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование заболевания | |||
|style="font-family: Courier;" |<dt:name>Ящур</dt:name> | |||
|- | |||
|82 | |||
|style="font-weight: bold; font-family: Courier;" |············</dt:relatedDisease> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|83 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:prosperity> | |||
|[[ProsperityType_v2.0|dt:ProsperityType]] | |||
|[1..1] | |||
|Статус благополучия: | |||
* UNDEFINED - не определялся | |||
* UNKNOWN - неизвестный | |||
* SAFE - благополучный | |||
* UNSAFE - неблагополучный | |||
|style="font-family: Courier;" |<dt:prosperity>UNSAFE</dt:prosperity> | |||
|- | |||
|84 | |||
|style="font-weight: bold; font-family: Courier;" |············<dt:vaccination> | |||
|[[VaccinationType_v2.0|dt:VaccinationType]] | |||
|[1..1] | |||
|Статус применения вакцины: | |||
* UNDEFINED - неопределенный | |||
* APPLIED - вакцинация проводится | |||
* UNVACCINATED - вакцинация не проводится | |||
|style="font-family: Courier;" |<dt:vaccination>APPLIED</dt:vaccination> | |||
|- | |||
|85 | |||
|style="font-weight: bold; font-family: Courier;" |·········</dt:r13nStatus> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|86 | |||
|style="font-weight: bold; font-family: Courier;" |······</dt:status> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|87 | |||
|style="font-weight: bold; font-family: Courier;" |···</dt:r13nRegionStatusList> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|88 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getActualR13nRegionStatusListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Описание ошибок== | ==Описание ошибок== | ||
Строка 242: | Строка 885: | ||
==Пример запроса== | ==Пример запроса== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Получение списка | Получение списка статусов регионализации Ростовской области по болезни "Грипп птиц". | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<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> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
</div> | </div> | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | |||
<!--<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | |||
Ответ на запрос. | Ответ на запрос. | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
Строка 257: | Строка 915: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
</div> | </div>--> | ||
<br /> | <br /> | ||
[[Category:Ветис.API]] | [[Category:Ветис.API]] | ||
[[Category:ProductService]] | [[Category:ProductService]] |
Текущая версия на 11:45, 31 октября 2017
Общие сведения
Операция GetActualR13nRegionStatusList предназначена для получения списка статусов регионов по конкретному заболеванию. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка статусов, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- глобальный идентификатор заболевания;
- (опционально) регион, по которому запрашиваются статусы.
Выходные данные
- список статусов регионов.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getActualR13nRegionStatusListRequest> | ||||
2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<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] | Список статусов региона:
|
|
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] | Является ли запись активной:
|
<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>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] | Является ли запись активной:
|
<bs:active>true</bs:active> |
75 | ···············<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<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] | Статус благополучия:
|
<dt:prosperity>UNSAFE</dt:prosperity> |
84 | ············<dt:vaccination> | dt:VaccinationType | [1..1] | Статус применения вакцины:
|
<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>