MercuryG2B:GetActualR13nRegionStatusList:v3.0

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

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

Код Описание операции
RS.MERC.1.2 Получение списка статусов регионов по конкретному заболеванию

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getActualR13nRegionStatusListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого спискаа
003 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000
004 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:disease> dt:AnimalDisease [1..1] Заболевание, к которому относятся запрашиваемые условия перемещения груза
007 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
008 ···</dt:disease>
009 ···<dt:r13nZone> dt:Area [0..1] (Опционально) Регион, по которому запрашиваются статусы
010 ······<dt:country> dt:Country [0..1] Описание страны
011 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
012 ······</dt:country>
013 ······<dt:region> dt:Region [0..1] Регион страны
014 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
015 ······</dt:region>
016 ······<dt:district> dt:District [0..1] Район региона
017 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
018 ······</dt:district>
019 ······<dt:locality> dt:Locality [0..1] Населенный пункт
020 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
021 ······</dt:locality>
022 ······<dt:sublocality> dt:Locality [0..1] Населенный пункт, подчинённый населённому пункту
023 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
024 ······</dt:sublocality>
025 ···</dt:r13nZone>
026 </dt:getActualR13nRegionStatusListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getActualR13nRegionStatusListResponse>
002 ···<dt:r13nRegionStatusList count="?" total="?" offset="?"> dt:RegionalizationRegionStatusList [1..1]

Список статусов региона:

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей
003 ······<dt:status> dt:RegionalizationRegionStatus [0..*] Статус региона
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии статуса региона
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор статуса региона
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Является ли запись активной:

  • true - запись активна;
  • false - запись не активна
007 ·········<bs:last>?</bs:last> xs:boolean [1..1]

Является ли версия записи последней:

  • true - да;
  • false - нет
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус версии записи
009 ·········<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания записи
010 ·········<bs:updateDate>?</bs:updateDate> xs:DateTime [1..1] Дата изменения записи
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
012 ·········<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<dt:referenceNumber>?</dt:referenceNumber> dt:Identifier [0..1] Номер статуса региона в реестре
014 ·········<dt:r13nZone> dt:Area [0..1] Регион, по которому запрашивались статусы
015 ············<dt:country> dt:Country [1..1] Страна
016 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны
017 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны
018 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
019 ············</dt:country>
020 ············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
021 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны
022 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны
023 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона страны
024 ············</dt:region>
025 ············<dt:district> dt:District [0..1] Район региона
026 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона
027 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона
028 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района региона
029 ············</dt:district>
030 ············<dt:locality> dt:Locality [0..1] Населённый пункт
031 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта
032 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта
033 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование насленного пункта
034 ············</dt:locality>
035 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
036 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта
037 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта
038 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
039 ············</dt:subLocality>
040 ············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
041 ·········</dt:r13nZone>
042 ·········<dt:excludedR13nZone> dt:Area [0..*] Территория/регион внутри `r13Zone` с отличным (другим) статусом регионализации
043 ············<dt:country> dt:Country [1..1] Страна
044 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны
045 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны
046 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
047 ············</dt:country>
048 ············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
049 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона страны
050 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны
051 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона страны
052 ············</dt:region>
053 ············<dt:district> dt:District [0..1] Район региона
054 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор района региона
055 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона
056 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района региона
057 ············</dt:district>
058 ············<dt:locality> dt:Locality [0..1] Населённый пункт
059 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта
060 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта
061 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование насленного пункта
062 ············</dt:locality>
063 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
064 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор населенного пункта
065 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта
066 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
067 ············</dt:subLocality>
068 ············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
069 ·········</dt:excludedR13nZone>
070 ·········<dt:r13nStatus> dt:RegionalizationStatus [0..*] Статус регионализации
071 ············<dt:relatedDisease> dt:AnimalDisease [1..1] Заболевание, по которому назначен статус
072 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания
073 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания
074 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование заболевания
075 ············</dt:relatedDisease>
076 ············<dt:prosperity>?</dt:prosperity> dt:ProsperityType [1..1]

Статус благополучия:

  • UNDEFINED - не определялся
  • UNKNOWN - неизвестный
  • SAFE - благополучный
  • UNSAFE - неблагополучный
077 ············<dt:vaccination>?</dt:vaccination> dt:VaccinationType [1..1]

Статус применения вакцины:

  • UNDEFINED - неопределенный
  • APPLIED - вакцинация проводится
  • UNVACCINATED - вакцинация не проводится
078 ·········</dt:r13nStatus>
079 ······</dt:status>
080 ···</dt:r13nRegionStatusList>
081 </dt:getActualR13nRegionStatusListResponse>

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0

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