CheckShipmentRegionalizationOperation v2: различия между версиями

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


== Данные запроса ==
== Данные запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Кардинальность
! Описание
! Пример
|-
| 1
| style="font-weight: bold; font-family: Courier;" | <merc:checkShipmentRegionalizationRequest>
|
|
|
|
|-
| 2
| style="font-weight: bold; font-family: Courier;" | ···<merc:localTransactionId>
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
| [1..1]
| Идентификатор заявки в клиентской системе.
| <bs:guid>A00001</bs:guid>
|-
| 3
| style="font-weight: bold; font-family: Courier;" | ···<merc:initiator>
| [[User_v2.0|dt:User]]
| [1..1]
| Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
|
|-
| 4
| style="font-weight: bold; font-family: Courier;" | ······&lt;dt:login>
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
| [1..1]
| Логин пользователя, зарегистрированного в системе Меркурий. Обязательно указывать один из параметров.
| &lt;dt:login>user_ab_150101</dt:login>
|-
| 5
| style="font-weight: bold; font-family: Courier;" | ···</merc:initiator>
|
|
|
|
|-
| 6
| style="font-weight: bold; font-family: Courier;" | ···&lt;dt:cargoType>
| [[SubProduct_v2.0|dt:SubProduct]]
| [1..1]
| Категория груза, для которой запрашиваются правила перемещения по маршруту.
|
|-
| 7
| style="font-weight: bold; font-family: Courier;" | ······<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии вида продукции.
| <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid>
|-
| 8
| style="font-weight: bold; font-family: Courier;" | ······<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор вида продукции.
| <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
|-
| 9
| style="font-weight: bold; font-family: Courier;" | ···&lt;dt:cargoType>
|
|
|
|
|-
| 10
| style="font-weight: bold; font-family: Courier;" | ···<vd:shipmentRoute>
| [[ShipmentRoute_v2.0 | vd:ShipmentRoute]]
| [0..1]
| Сведения о маршруте следования (пунктах перегрузки).
|
|-
| 11
| style="font-weight: bold; font-family: Courier;" | ······<vd:routePoint>
| [[ShipmentRoutePoint_v2.0 | vd:ShipmentRoutePoint]]
| [0..*]
| Сведения о точке маршрута. Обязательно должно быть заполнено хотя бы одно из полей, либо location либо enterprise.
|
|-
| 12
| style="font-weight: bold; font-family: Courier;" | ·········<bs:uuid>
| [[UUID|bs:UUID]]
| [1..1]
| Идентификатор версии точки маршрута.
| <bs:uuid>cbd91ac0-bec2-4308-a395-33b68871d76b</bs:uuid>
|-
| 13
| style="font-weight: bold; font-family: Courier;" | ·········<vd:sqnId>
| [[SequenceNumber_v2.0|bs:SequenceNumber]]
| [1..1]
| Порядовый номер точки маршрута. Устанавливается системой автоматически. Может быть использован для идентификации точки при изменении параметров маршрута.
| <vd:sqnId>3</vd:sqnId>
|-
| 14
| style="font-weight: bold; font-family: Courier;" | ·········<vd:location>
| [[Location_v2.0 | dt:Location]]
| [0..1]
| Сведения о точке маршрута.
|
|-
| 15
| style="font-weight: bold; font-family: Courier;" | ············&lt;dt:name>
| [[String255|bs:String255]]
| [0..1]
| Название точки маршрута.
| &lt;dt:name>Перегрузочный пункт №812</dt:name>
|-
| 16
| style="font-weight: bold; font-family: Courier;" | ············&lt;dt:address>
|
|
|
|
|-
| 17
| style="font-weight: bold; font-family: Courier;" | ···············&lt;dt:country>
| [[Country_v2.0|dt:Country]]
| [1..1]
| Описание страны.
|
|-
| 18
| style="font-weight: bold; font-family: Courier;" | ··················<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии страны.
| <bs:uuid>cbd91ac0-bec2-4308-a395-33b68871d76b</bs:uuid>
|-
| 19
| style="font-weight: bold; font-family: Courier;" | ··················<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор страны.
| <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid>
|-
| 20
| style="font-weight: bold; font-family: Courier;" | ···············</dt:country>
|
|
|
|
|-
| 21
| style="font-weight: bold; font-family: Courier;" | ···············&lt;dt:region>
| [[Region_v2.0|dt:Region]]
| [0..1]
| Регион страны.
|
|-
| 22
| style="font-weight: bold; font-family: Courier;" | ··················<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии региона.
| <bs:uuid>0ae56b5c-6844-4c87-9a57-07a9d8979a7a</bs:uuid>
|-
| 23
| style="font-weight: bold; font-family: Courier;" | ··················<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор региона.
| <bs:guid>0d4ab22b-0461-4ef1-a151-05162558d89c</bs:guid>
|-
| 24
| style="font-weight: bold; font-family: Courier;" | ···············</dt:region>
|
|
|
|
|-
| 25
| style="font-weight: bold; font-family: Courier;" | ···············&lt;dt:district>
| [[District_v2.0|dt:District]]
| [0..1]
| Район региона.
|
|-
| 26
| style="font-weight: bold; font-family: Courier;" | ··················<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии района.
| <bs:uuid>851cf860-e9a3-4981-b83e-3dc6cb06cf07</bs:uuid>
|-
| 27
| style="font-weight: bold; font-family: Courier;" | ··················<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор района.
| <bs:guid>c9862fa8-e7cb-4b01-a62f-eba8328a6a2c</bs:guid>
|-
| 28
| style="font-weight: bold; font-family: Courier;" | ···············</dt:district>
|
|
|
|
|-
| 29
| style="font-weight: bold; font-family: Courier;" | ···············&lt;dt:locality>
| [[Locality_v2.0|dt:Locality]]
| [0..1]
| Населённый пункт.
|
|-
| 30
| style="font-weight: bold; font-family: Courier;" | ··················<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии населенного пункта.
| <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid>
|-
| 31
| style="font-weight: bold; font-family: Courier;" | ··················<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор населенного пункта.
| <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
|-
| 32
| style="font-weight: bold; font-family: Courier;" | ···············</dt:locality>
|
|
|
|
|-
| 33
| style="font-weight: bold; font-family: Courier;" | ···············&lt;dt:subLocality>
| [[Locality_v2.0|dt:Locality]]
| [0..1]
| Населённый пункт, подчинённый населённому пункту.
|
|-
| 34
| style="font-weight: bold; font-family: Courier;" | ··················<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии населенного пункта.
| <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
|-
| 35
| style="font-weight: bold; font-family: Courier;" | ··················<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор населенного пункта.
| <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
|-
| 36
| style="font-weight: bold; font-family: Courier;" | ···············</dt:subLocality>
|
|
|
|
|-
| 37
| style="font-weight: bold; font-family: Courier;" | ············</dt:address>
|
|
|
|
|-
| 38
| style="font-weight: bold; font-family: Courier;" | ·········</vd:location>
|
|
|
|
|-
| 39
| style="font-weight: bold; font-family: Courier;" | ·········<vd:enterprise>
| [[Enterprise_v2.0|dt:Enterprise]]
| [0..1]
| Сведения о предприятии, которое является точкой маршрута.
|
|-
| 40
| style="font-weight: bold; font-family: Courier;" | ············<bs:uuid>
| [[UUID|bs:UUID]]
| [0..1]
| Идентификатор версии предприятия.
| <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
|-
| 41
| style="font-weight: bold; font-family: Courier;" | ············<bs:guid>
| [[UUID|bs:UUID]]
| [0..1]
| Глобальный идентификатор предприятия.
| <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
|-
| 42
| style="font-weight: bold; font-family: Courier;" | ·········</vd:enterprise>
|
|
|
|
|-
| 43
| style="font-weight: bold; font-family: Courier;" | ·········<vd:transshipment>
| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
| [1..1]
| Признак того, осуществляется ли в данной точке перегрузка.
| <vd:transshipment>true</vd:transshipment>
|-
| 44
| style="font-weight: bold; font-family: Courier;" | ·········<vd:nextTransport>
| [[TransportInfo_v2.0 |dt:TransportInfo]]
| [0..1]
| Сведения о дальнейшем транспорте.
|
|-
| 45
| style="font-weight: bold; font-family: Courier;" | ············<vd:transportType>
| [[TransportType_v2.0|dt:TransportType]]
| [1..1]
| Тип транспортного средства.
| <vd:transportType>2</vd:transportType>
|-
| 46
| style="font-weight: bold; font-family: Courier;" | ············<vd:transportNumber>
| [[TransportNumber_v2.0 | dt:TransportNumber]]
| [1..1]
| Номер транспортного средства.
|
|-
| 47
| style="font-weight: bold; font-family: Courier;" | ···············<vd:containerNumber>
| [[String255|bs:String255]]
| [0..1]
| Номер контейнера (при автомобильной перевозке).
| <vd:containerNumber>п962но65</vd:containerNumber>
|-
| 48
| style="font-weight: bold; font-family: Courier;" | ···············<vd:wagonNumber>
| [[String255|bs:String255]]
| [0..1]
| Номер вагона.
| <vd:wagonNumber>72543291</vd:wagonNumber>
|-
| 49
| style="font-weight: bold; font-family: Courier;" | ···············<vd:vehicleNumber>
| [[String255|bs:String255]]
| [0..1]
| Номер автомобиля.
| <vd:vehicleNumber>а514ко33</vd:vehicleNumber>
|-
| 50
| style="font-weight: bold; font-family: Courier;" | ···············<vd:trailerNumber>
| [[String255|bs:String255]]
| [0..1]
| Номер прицепа (полуприцепа).
| <vd:trailerNumber>о721ен24</vd:trailerNumber>
|-
| 51
| style="font-weight: bold; font-family: Courier;" | ···············<vd:shipName>
| [[String255|bs:String255]]
| [0..1]
| Название судна (или номер контейнера).
| <vd:shipName>AMTU4003372</vd:shipName>
|-
| 52
| style="font-weight: bold; font-family: Courier;" | ···············<vd:flightNumber>
| [[String255|bs:String255]]
| [0..1]
| Номер авиарейса.
| <vd:flightNumber>YC-464</vd:flightNumber>
|-
| 53
| style="font-weight: bold; font-family: Courier;" | ············</vd:transportNumber>
|
|
|
|
|-
| 54
| style="font-weight: bold; font-family: Courier;" | ·········</vd:nextTransport>
|
|
|
|
|-
| 55
| style="font-weight: bold; font-family: Courier;" | ······</vd:routePoint>
|
|
|
|
|-
| 56
| style="font-weight: bold; font-family: Courier;" | ···</vd:shipmentRoute>
|
|
|
|
|-
| 56
| style="font-weight: bold; font-family: Courier;" | </merc:checkShipmentRegionalizationRequest>
|
|
|
|
|}


== Данные ответа ==
== Данные ответа ==

Версия 22:50, 18 июля 2017

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

Операция 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 ······<dt:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий. Обязательно указывать один из параметров. <dt:login>user_ab_150101</dt: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>

Данные ответа

Вернуться к началу ↑