MercuryG2B:GetActualR13nShippingRuleList:v3.0

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:GetActualR13nShippingRuleList>
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 ···<vd:productType>?</vd:productType> dt:productType [0..1] Глобальный идентификатор записи
010 ···<vd:product> dt:Product [0..1]

Ветеринарная категория груза (продукция), для которой запрашиваются правила перемещения

  • Обязательно должен быть указан один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
011 ······<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии продукции
012 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор версии продукции
013 ···</vd:product>
014 ···<vd:subProduct> dt:SubProduct [0..1]

Ветеринарная категория груза (вид продукции), для которой запрашиваются правила перемещения

  • Обязательно должен быть указан один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
015 ······<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии продукции
016 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор версии продукции
017 ···</vd:subProduct>
018 </ws:GetActualR13nShippingRuleList>

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

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

Тип, описывающий список условий перемещения

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей
003 ······<vd:rule> dt:RegionalizationCondition [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:from13nStatus> dt:RegionalizationCondition [0..1] Применяемое правило перемещения для каждой категории груза на данном участке маршрута
015 ············<dt:relatedDisease> dt:RegionalizationCondition [0..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:relatedDisease>
020 ············<dt:prosperity>?</dt:prosperity> dt:ProsperityType [1..1]

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

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

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

  • UNDEFINED - неопределенный
  • APPLIED - вакцинация проводится
  • UNVACCINATED - вакцинация не проводится
022 ·········</dt:from13nStatus>
023 ·········<dt:toR13nStatus> dt:RegionalizationStatus [0..1] Статус территории, куда партия направляется (место назначения), согласно регионализации
024 ············<dt:relatedDisease> dt:RegionalizationCondition [1..1] Применяемое правило перемещения для каждой категории груза на данном участке маршрута
025 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания
026 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания
027 ···············<dt:name>?</dt:name> dt:Identifier [1..1] Наименование заболевания
028 ············</dt:relateDisease>
029 ············<dt:prosperity>?</dt:prosperity> dt:ProsperityType [1..1]

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

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

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

  • UNDEFINED - неопределенный
  • APPLIED - вакцинация проводится
  • UNVACCINATED - вакцинация не проводится
031 ·········</dt:toR13nStatus>
032 ·········<dt:cargoType> dt:SubProduct [0..*] Ветеринарная категория груза, на которую распространяется правило перемещения
033 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукции
034 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции
035 ·········</dt:cargoType>
036 ·········<dt:decision>?</dt:decision> dt:RegionalizationDecision [0..1] Решение о возможности перемещения груза: перемещение запрещено, перемещение разрешено или перемещение разрешено при обязательном соблюдении условий
037 ·········<dt:requirement>?</dt:requirement> dt:RegionalizationRequirement [1..*] Требование к перемещению партии в отношении к определенному заболеванию
038 ············<dt:type>?</dt:type> dt:RegionalizationDecision [1..1]

Вид требования:

  • Перемещение запрещено, перемещение разрешено или перемещение разрешено при обязательном соблюдении условий
039 ············<dt:conditionGroup>?</dt:conditionGroup> dt:RegionalizationConditionGroup [1..1]

Группа условий регионализации, соблюдаемых при перевозке продукции:/span>

  • Имеет смысл, если тип требования `type` имеет значение 2 (перемещение разрешено при обязательном соблюдении условий). В этом случае требование считается выполненным, если выполнена одна из альтернативных групп условий `conditionGroup`. См. условие выполнения группы в описании типа `dt:RegionalizationConditionGroup`
040 ···············<dt:condition> dt:RegionalizationCondition [0..*] Условие регионализации, соблюдаемое при перевозке груза
041 ··················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии условия регионализации
042 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор условия регионализации
043 ··················<dt:referenceNumber>?</dt:referenceNumber> dt:Identifier [1..1] Номер статуса региона в реестре
044 ··················<dt:text>?</dt:text> bs:Text [1..1] Формулировка условия
045 ··················<dt:strict>?</dt:strict> xs:boolean [1..1] Обязательность соблюдения условия
046 ··················<dt:relatedDisease> dt:AnimalDisease [1..*] Заболевание, к которому относится данное условие
047 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания
048 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания
049 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование заболевания
050 ··················</dt:relateDisease>
051 ···············</dt:condition>
052 ············</dt:conditionGroup>
053 ·········</dt:requirement>
054 ······</vd:rule>
055 ···</dt:r13nShippingRuleList>
056 </dt:getActualR13nShippingRuleListResponse>

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

TODO

См. также

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