CheckShipmentRegionalizationOperation v2
Общие сведения
Операция CheckShipmentRegionalizationOperation предназначена для проверки возможности осуществления перевозки в рамках регионализации. В запросе указывается маршрут перемещения партии и перемещаемая продукция, для каждого отрезка маршрута в ответ придет одно из следующих решений:
- перемещение запрещено;
- перемещение разрешено;
- перемещение разрешено при выполнении дополнительных условий.
Если перемещение разрешено при выполнении дополнительных условий, то пользователь также получит список всех необходимых условий. Данный список условий необходимо передаваться в запросе на создание транспортной партии для оформления ВСД. Передавая список условий пользователь подтверждает выполнение указанных условий. Если перемещение запрещено, то ВСД для данной продукции с указанным маршрутом не сможет быть оформлен.
При выполнении операции CheckShipmentRegionalizationOperation на вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- список перемещаемой продукции на уровне ветеринарной группы (третий уровень иерархического справочника продукции ФГИС "Меркурий");
- маршрут следования. В маршруте следования помимо пунктов перегрузки (если они есть) указывается начальная и конечная точки.
Результатом выполнения данной операции является:
- Решение о возможности перемещения указанной продукции по указанному маршруту;
- Список условий, в случае, если перемещение возможно при выполнении дополнительных условий.
Возможные сценарии
При обработке запроса возможны следующие сценарии:
- 1.1. Запрос успешно обработан. Пользователю вернулся ответ о возможности перемещения партии.
- 1.2. Произошла ошибка при обработке запроса.
- • Некорректный запрос.
- • Внутренняя ошибка системы.
Используемые пространства имен
|
|
Данные запроса
| # | Название XML-элемента | Тип | Кардинальность | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <merc:checkShipmentRegionalizationRequest> | ||||
| 2 | ···<merc:localTransactionId> | xs:NCName | [1..1] | Идентификатор заявки в клиентской системе. | <bs:guid>A00001</bs:guid> |
| 3 | ···<merc:initiator> | dt:User | [1..1] | Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт. | |
| 4 | ······<vd:login> | xs:NCName | [1..1] | Логин пользователя, зарегистрированного в системе Меркурий. Обязательно указывать один из параметров. | <vd:login>user_ab_150101</vd:login> |
| 5 | ···</merc:initiator> | ||||
| 6 | ···<dt:cargoType> | dt:SubProduct | [1..1] | Категория груза, для которой запрашиваются правила перемещения по маршруту. | |
| 7 | ······<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии вида продукции. | <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid> |
| 8 | ······<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор вида продукции. | <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid> |
| 9 | ···<dt:cargoType> | ||||
| 10 | ···<vd:shipmentRoute> | vd:ShipmentRoute | [0..1] | Сведения о маршруте следования (пунктах перегрузки). | |
| 11 | ······<vd:routePoint> | vd:ShipmentRoutePoint | [0..*] | Сведения о точке маршрута. Обязательно должно быть заполнено хотя бы одно из полей, либо location либо enterprise. | |
| 12 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии точки маршрута. | <bs:uuid>cbd91ac0-bec2-4308-a395-33b68871d76b</bs:uuid> |
| 13 | ·········<vd:sqnId> | bs:SequenceNumber | [1..1] | Порядовый номер точки маршрута. Устанавливается системой автоматически. Может быть использован для идентификации точки при изменении параметров маршрута. | <vd:sqnId>3</vd:sqnId> |
| 14 | ·········<vd:location> | dt:Location | [0..1] | Сведения о точке маршрута. | |
| 15 | ············<dt:name> | bs:String255 | [0..1] | Название точки маршрута. | <dt:name>Перегрузочный пункт №812</dt:name> |
| 16 | ············<dt:address> | ||||
| 17 | ···············<dt:country> | dt:Country | [1..1] | Описание страны. | |
| 18 | ··················<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии страны. | <bs:uuid>cbd91ac0-bec2-4308-a395-33b68871d76b</bs:uuid> |
| 19 | ··················<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор страны. | <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid> |
| 20 | ···············</dt:country> | ||||
| 21 | ···············<dt:region> | dt:Region | [0..1] | Регион страны. | |
| 22 | ··················<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии региона. | <bs:uuid>0ae56b5c-6844-4c87-9a57-07a9d8979a7a</bs:uuid> |
| 23 | ··················<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор региона. | <bs:guid>0d4ab22b-0461-4ef1-a151-05162558d89c</bs:guid> |
| 24 | ···············</dt:region> | ||||
| 25 | ···············<dt:district> | dt:District | [0..1] | Район региона. | |
| 26 | ··················<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии района. | <bs:uuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</bs:uuid> |
| 27 | ··················<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор района. | <bs:guid>c9862fa8-e7cb-4b01-a62f-eba8328a6a2c</bs:guid> |
| 28 | ···············</dt:district> | ||||
| 29 | ···············<dt:locality> | dt:Locality | [0..1] | Населённый пункт. | |
| 30 | ··················<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии населенного пункта. | <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid> |
| 31 | ··················<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор населенного пункта. | <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid> |
| 32 | ···············</dt:locality> | ||||
| 33 | ···············<dt:subLocality> | dt:Locality | [0..1] | Населённый пункт, подчинённый населённому пункту. | |
| 34 | ··················<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии населенного пункта. | <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid> |
| 35 | ··················<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор населенного пункта. | <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid> |
| 36 | ···············</dt:subLocality> | ||||
| 37 | ············</dt:address> | ||||
| 38 | ·········</vd:location> | ||||
| 39 | ·········<vd:enterprise> | dt:Enterprise | [0..1] | Сведения о предприятии, которое является точкой маршрута. | |
| 40 | ············<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии предприятия. | <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid> |
| 41 | ············<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор предприятия. | <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid> |
| 42 | ·········</vd:enterprise> | ||||
| 43 | ·········<vd:transshipment> | xs:boolean | [1..1] | Признак того, осуществляется ли в данной точке перегрузка. | <vd:transshipment>true</vd:transshipment> |
| 44 | ·········<vd:nextTransport> | dt:TransportInfo | [0..1] | Сведения о дальнейшем транспорте. | |
| 45 | ············<vd:transportType> | dt:TransportType | [1..1] | Тип транспортного средства. | <vd:transportType>2</vd:transportType> |
| 46 | ············<vd:transportNumber> | dt:TransportNumber | [1..1] | Номер транспортного средства. | |
| 47 | ···············<vd:containerNumber> | bs:String255 | [0..1] | Номер контейнера (при автомобильной перевозке). | <vd:containerNumber>п962но65</vd:containerNumber> |
| 48 | ···············<vd:wagonNumber> | bs:String255 | [0..1] | Номер вагона. | <vd:wagonNumber>72543291</vd:wagonNumber> |
| 49 | ···············<vd:vehicleNumber> | bs:String255 | [0..1] | Номер автомобиля. | <vd:vehicleNumber>а514ко33</vd:vehicleNumber> |
| 50 | ···············<vd:trailerNumber> | bs:String255 | [0..1] | Номер прицепа (полуприцепа). | <vd:trailerNumber>о721ен24</vd:trailerNumber> |
| 51 | ···············<vd:shipName> | bs:String255 | [0..1] | Название судна (или номер контейнера). | <vd:shipName>AMTU4003372</vd:shipName> |
| 52 | ···············<vd:flightNumber> | bs:String255 | [0..1] | Номер авиарейса. | <vd:flightNumber>YC-464</vd:flightNumber> |
| 53 | ············</vd:transportNumber> | ||||
| 54 | ·········</vd:nextTransport> | ||||
| 55 | ······</vd:routePoint> | ||||
| 56 | ···</vd:shipmentRoute> | ||||
| 56 | </merc:checkShipmentRegionalizationRequest> |
Данные ответа
| # | Название XML-элемента | Тип | Кардинальность | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <merc:checkShipmentRegionalizationResponse> | ||||
| 2 | ···<vd:r13nRouteSection> | vd:RouteSectionR13nRules | [0..*] | Описание правил перемещения продукции. Количество элементов `r13nRouteSection` в ответе соответствует количеству отрезков маршрута. Атрибут `r13nRouteSection/sqnId` равен номеру отрезка, нумерация начинается с единицы. Количество элементов `r13nRouteSection/appliedR13nRule` соответствует количеству категорий груза (элемент `cargoType`) в запросе. | |
| 3 | ······<vd:sqnId> | bs:SequenceNumber | [0..1] | Порядовый номер отрезка маршрута. | <vd:sqnId>1</vd:sqnId> |
| 4 | ······<vd:appliedR13nRule> | dt:RegionalizationShippingRule | [0..*] | Применяемое правило перемещения для каждой категории груза на данном участке маршрута. | |
| 5 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии правила перемещения. | <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> |
| 6 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор правила перемещения. | <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid> |
| 7 | ·········<bs:active> | xs:boolean | [1..1] | Является ли запись о правиле перемещения активной:
|
<bs:active>true</bs:active> |
| 8 | ·········<bs:last> | xs:boolean | [1..1] | Последняя версия правила перемещения:
|
<bs:last>true</bs:last> |
| 9 | ·········<bs:status> | bs:VersionStatus | [1..1] | Статус версии правила перемещения. | <bs:status></bs:status> |
| 10 | ·········<bs:createDate> | xs:DateTime | [1..1] | Дата создания правила перемещения. | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
| 11 | ·········<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения правила перемещения. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
| 12 | ·········<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии правила перемещения. | <bs:previous>7c78bf3f-c1e8-496b-a5c1-173af60e95e4</bs:previous> |
| 13 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии правила перемещения. | <bs:next>82c7af0d-7067-4a67-8a53-39f4a5bcd700</bs:next> |
| 14 | ·········<bs:referenceNumber> | bs:Identifier | [0..1] | Номер правила перевозки в реестре. | |
| 15 | ·········<dt:fromR13nStatus> | dt:RegionalizationStatus | [0..1] | Статус территории, откуда партия отправляется (место отправления), согласно регионализации. | |
| 16 | ·········<dt:toR13nStatus> | dt:RegionalizationStatus | [0..1] | Статус территории, куда партия направляется (место назначения), согласно регионализации. | |
| 17 | ·········<dt:cargoType> | dt:SubProduct | [0..*] | Ветеринарная категория груза, на которую распространяется правило перемещения. | |
| 18 | ············<bs:uuid> | bs:UUID | [0..1] | Идентификатор версии вида продукции. | <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid> |
| 19 | ············<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор вида продукции. | <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid> |
| 20 | ·········<dt:cargoType> | ||||
| 21 | ·········<dt:decision> | dt:RegionalizationDecision | [0..1] | Решение о возможности перемещения груза: перемещение запрещено, перемещение разрешено или перемещение разрешено при обязательном соблюдении условий. | |
| 22 | ·········<dt:requirement> | dt:RegionalizationRequirement | [0..*] | Требование к перемещению партии в отношении к определенному заболеванию. | |
| 23 | ············<dt:relatedDisease> | dt:AnimalDisease | [0..1] | Заболевание, к которому относится данное требование | |
| 24 | ···············<bs:uuid> | bs:UUID | [0..1] | Идентификатор заболевания. | <bs:uuid>cbd91ac0-bec2-4308-a395-33b68871d76b</bs:uuid> |
| 25 | ···············<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор заболевания. | <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid> |
| 26 | ···············<dt:name> | bs:String255 | [0..1] | Название заболевания. | <dt:name>Ящур</dt:name> |
| 27 | ············</dt:relatedDisease> | ||||
| 28 | ············<dt:type> | dt:RegionalizationDecision | [1..1] | Вид требования: перемещение запрещено, перемещение разрешено или перемещение разрешено при обязательном соблюдении условий. | |
| 29 | ············<dt:conditionGroup> | dt:RegionalizationConditionGroup | [0..*] | Группа условий регионализации, соблюдаемых при перевозке продукции. Имеет смысл, если тип требования `type` имеет значение 3 (перемещение разрешено при обязательном соблюдении условий). В этом случае требование считается выполненным, если выполнена одна из альтернативных групп условий `conditionGroup`. См. условие выполнения группы в описании типа `dt:RegionalizationConditionGroup`. | |
| 30 | ···············<dt:condition> | dt:RegionalizationCondition | [0..*] | Условие регионализации, соблюдаемое при перевозке груза | |
| 31 | ··················<bs:referenceNumber> | bs:Identifier | [0..1] | Номер условия. | |
| 32 | ··················<bs:text> | bs:Text | [0..1] | Формулировка условия. | |
| 33 | ··················<bs:strict> | xs:boolean | [0..1] | Обязательность соблюдения условия. | |
| 34 | ··················<dt:relatedDisease> | dt:AnimalDisease | [0..*] | Заболевание, к которому относится данное условие. | |
| 35 | ·····················<bs:uuid> | bs:UUID | [0..1] | Идентификатор заболевания. | <bs:uuid>cbd91ac0-bec2-4308-a395-33b68871d76b</bs:uuid> |
| 36 | ·····················<bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор заболевания. | <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid> |
| 37 | ·····················<dt:name> | bs:String255 | [0..1] | Название заболевания. | <dt:name>Ящур</dt:name> |
| 38 | ··················</dt:relatedDisease> | ||||
| 39 | ···············</dt:condition> | ||||
| 40 | ············</dt:conditionGroup> | ||||
| 41 | ·········</dt:requirement> | ||||
| 42 | ······</vd:appliedR13nRule> | ||||
| 43 | ···</vd:r13nRouteSection> | ||||
| 44 | <merc:checkShipmentRegionalizationResponse> |
Примеры запросов
Запрос 1. Получение условий регионализации для маршрута.
Получение условий регионализации
Ответ на запрос 1
