MercuryG2B:CheckShipmentRegionalization:v3.0

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

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

Код операции Описание операции
... Проверка возможности осуществления перевозки партии в рамках правил регионализации

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:checkShipmentRegionalizationRequest>
002 ···<merc:localTransactionId>?</merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе
003 ···<merc:initiator> vd:User [1..1]

Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу

  • Является ответственным за выполнение бизнес-операции
  • Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий
005 ···</merc:initiator>
006 ···<dt:cargoType> dt:SubProduct [1..*]

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

  • Третий уровень иерархического справочника продукции ИС Меркурий
  • Обязательно указывать один из идентификаторов: uuid или guid; при указании обоих приоритет у uuid
007 ······<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии вида продукции
008 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор вида продукции
009 ···</dt:cargoType>
010 ···<vd:shipmentRoute> vd:ShipmentRoute [1..1]

Сведения о маршруте следования (пунктах перегрузки)

  • Должно быть указано минимум 2 точки в маршруте
011 ······<vd:routePoint> vd:ShipmentRoutePoint [1..*]

Сведения о точке маршрута

  • Обязательно должно быть заполнено хотя бы одно из полей, либо location либо enterprise
012 ·········<bs:sqnId>?</bs:sqnId> bs:SequenceNumber [0..1]

Порядовый номер точки маршрута

  • Не обязателен для заполнения, будет сгенерирован автоматически в ответе
013 ·········<vd:location> dt:Location [0..1]

Сведения о точке маршрута

  • Указывается в случае, если не указано значение enterpise
014 ············<dt:address>
015 ···············<dt:country> dt:Country [1..1] Страна
016 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор страны в соответствии со справочником РСХН
017 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор страны в соответствии со справочником РСХН
018 ···············</dt:country>
019 ···············<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
020 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор региона в соответствии со справочником РСХН
021 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор региона в соответствии со справочником РСХН
022 ···············</dt:region>
023 ···············<dt:district> dt:District [0..1] Район региона
024 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор района региона в соответствии со справочником РСХН
025 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор района региона в соответствии со справочником РСХН
026 ···············</dt:district>
027 ···············<dt:locality> dt:Locality [0..1] Населённый пункт
028 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор населенного пункта в соответствии со справочником РСХН
029 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН
030 ···············</dt:locality>
031 ···············<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
032 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор населенного пункта в соответствии со справочником РСХН
033 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН
034 ···············</dt:subLocality>
035 ············</dt:address>
036 ·········</vd:location>
037 ·········<vd:enterprise> dt:Enterprise [0..1]

Сведения о предприятии, которое является точкой маршрута

  • Обязательно указывать один из идентификаторов: uuid или guid; при указании обоих приоритет у uuid
  • Указывается в случае, если не указано значение location
038 ············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор предприятия
039 ············<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор предприятия
040 ·········</vd:enterprise>
041 ······</vd:routePoint>
042 ···</vd:shipmentRoute>
043 </merc:checkShipmentRegionalizationRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:checkShipmentRegionalizationResponse
002 ···<vd:r13nRouteSection> vd:RouteSectionR13nRules [1..*]

Описание правил перемещения продукции

  • Количество элементов `r13nRouteSection` в ответе соответствует количеству отрезков маршрута
  • Атрибут `r13nRouteSection/sqnId` равен номеру отрезка, нумерация начинается с единицы
  • Количество элементов `r13nRouteSection/appliedR13nRule` соответствует количеству категорий груза (элемент `cargoType`) в запросе
003 ······<vd:sqnId>?</vd:sqnId> bs:SequenceNumber [1..1] Порядовый номер отрезка маршрута
004 ······<vd:appliedR13nRule> dt:RegionalizationShippingRule [1..*] Применяемое правило перемещения для каждой категории груза на данном участке маршрута
005 ·········<dt:cargoType> dt:SubProduct [1..*] Ветеринарная категория груза, на которую распространяется правило перемещения
006 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукцииа
007 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции
008 ············<dt:name>?</dt:name> bs:String255 [1..1] Название вида продукции
009 ·········</dt:cargoType>
010 ·········<dt:decision>?</dt:decision> dt:RegionalizationDecision [1..1]

Решение о возможности перемещения груза

  • 1 - перемещение разрешено
  • 2 - перемещение разрешено при обязательном соблюдении условий
  • 3 - перемещение запрещено
011 ·········<dt:requirement> dt:RegionalizationRequirement [0..*] Требование к перемещению партии в отношении к определенному заболеванию
012 ············<dt:relatedDisease> dt:AnimalDisease [1..1] Заболевание, к которому относится данное требование
013 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор заболевания
014 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания
015 ···············<dt:name>?</dt:name> bs:String255 [1..1] Название заболевания
016 ············</dt:relatedDisease>
017 ············<dt:type>?</dt:type> dt:RegionalizationDecision [1..1]

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

  • 1 - перемещение разрешено
  • 2 - перемещение разрешено при обязательном соблюдении условий
  • 3 - перемещение запрещено
018 ············<dt:conditionGroup> dt:RegionalizationConditionGroup [0..*]

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

  • Имеет смысл, если тип требования `type` имеет значение 2 (перемещение разрешено при обязательном соблюдении условий). В этом случае требование считается выполненным, если выполнена одна из альтернативных групп условий `conditionGroup`. См. условие выполнения группы в описании типа `dt:RegionalizationConditionGroup`
019 ···············<dt:condition> dt:RegionalizationCondition [1..*] Условие регионализации, соблюдаемое при перевозке груза
020 ··················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии условия регионализации
021 ··················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор условия регионализации
022 ··················<dt:referenceNumber>?</dt:referenceNumber> bs:Identifier [1..1] Номер условия регионализации
023 ··················<dt:text>?</dt:text> bs:Text [1..1] Формулировка условия регионализации
024 ··················<dt:strict>?</dt:strict> xs:boolean [0..1] Обязательность соблюдения условия регионализации
025 ··················<dt:relatedDisease> dt:AnimalDisease [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:relatedDisease>
030 ···············</dt:condition>
031 ············</dt:conditionGroup>
032 ·········</dt:requirement>
033 ······</vd:appliedR13nRule>
034 ···</vd:r13nRouteSection>
035 </merc:checkShipmentRegionalizationResponse>

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

TODO

См. также

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

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