GetActualR13nShippingRuleList v2.0

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

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

Операция GetActualR13nShippingRuleList предназначена для получения списка правил перемещения грузов по конкретному заболеванию. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода и фильтрации по категориям продукции. Выполнение операции заканчивается либо возвратом списка статусов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

Входные данные

  • параметры выводимого списка;
  • глобальный идентификатор заболевания;
  • (опционально) идентификатор типа продукции (1 уровень иерархического справочника продукции);
  • (опционально) идентификатор продукции (2 уровень иерархического справочника продукции);
  • (опционально) идентификатор вида продукции (3 уровень иерархического справочника продукции).

Выходные данные

  • список правил перемещения.

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getActualR13nShippingRuleListRequest>
2 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
3 ······<bs:count> xs:nonNegativeInteger [0..1] Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
 <bs:count>10</bs:count>
4 ······<bs:offset> xs:nonNegativeInteger [0..1] Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
 <bs:offset>2</bs:offset>
5 ···</bs:listOptions>
6 ···<dt:disease> dt:AnimalDisease [1..1] Заболевание, к которому относятся запрашиваемые условия перемещения груза.
7 ······<bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания. <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid>
8 ···</dt:disease>
9 ···<vd:productType> dt:ProductType [0..1] Ветеринарная категория груза (тип продукции), для которой запрашиваются правила перемещения. <vd:productType>1</vd:productType>
10 ···<vd:product> dt:Product [0..1] Ветеринарная категория груза (продукция), для которой запрашиваются правила перемещения.
  • Обязательно должен быть указан один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid.
11 ······<bs:uuid> bs:UUID [0..1] Идентификатор версии продукции. <bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
12 ······<bs:guid> bs:UUID [0..1] Глобальный идентификатор продукции. <bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
13 ···</vd:product>
14 ···<vd:subProduct> dt:SubProduct [0..1] Ветеринарная категория груза (вид продукции), для которой запрашиваются правила перемещения.
  • Обязательно должен быть указан один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid.
15 ······<bs:uuid> bs:UUID [0..1] Идентификатор версии вида продукции. <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid>
16 ······<bs:guid> bs:UUID [0..1] Глобальный идентификатор вида продукции. <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
17 ···</vd:subProduct>
18 </ws:getActualR13nShippingRuleListRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getActualR13nShippingRuleListResponse>
2 ···<dt:r13nShippingRuleList count="36" total="36" offset="0"> dt:RegionalizationShippingRuleList [1..1] Список правил перемещения груза (регионализация).
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
3 ······<vd:rule> dt:RegionalizationShippingRule [0..*] Применяемое правило перемещения для каждой категории груза на данном участке маршрута.
4 ·········<bs:uuid> bs:UUID [1..1] Идентификатор версии правила перемещения. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
5 ·········<bs:guid> bs:UUID [1..1] Глобальный идентификатор правила перемещения. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
6 ·········<bs:active> xs:boolean [1..1] Является ли запись о правиле перемещения активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
7 ·········<bs:last> xs:boolean [1..1] Последняя версия правила перемещения:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
8 ·········<bs:status> bs:VersionStatus [1..1] Статус версии правила перемещения. <bs:status></bs:status>
9 ·········<bs:createDate> xs:DateTime [1..1] Дата создания правила перемещения. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
10 ·········<bs:updateDate> xs:DateTime [1..1] Дата изменения правила перемещения. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
11 ·········<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии правила перемещения. <bs:previous>7c78bf3f-c1e8-496b-a5c1-173af60e95e4</bs:previous>
12 ·········<bs:next> bs:UUID [0..1] Идентификатор следующей версии правила перемещения. <bs:next>82c7af0d-7067-4a67-8a53-39f4a5bcd700</bs:next>
13 ·········<bs:referenceNumber> bs:Identifier [0..1] Номер правила перевозки в реестре.
14 ·········<dt:fromR13nStatus> dt:RegionalizationStatus [0..1] Статус территории, откуда партия отправляется (место отправления), согласно регионализации.
15 ············<dt:relatedDisease> dt:AnimalDisease [1..1] Заболевание, по которому назначен статус
16 ···············<bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
17 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
18 ···············<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
19 ···············<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
20 ···············<bs:status> bs:VersionStatus [1..1] Статус версии заболевания. <bs:status>100</bs:status>
21 ···············<bs:createDate> xs:DateTime [1..1] Дата создания заболевания. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
22 ···············<bs:updateDate> xs:DateTime [1..1] Дата изменения заболевания. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
23 ···············<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра заболевания. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
24 ···············<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра заболевания. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
25 ···············<dt:name> bs:String255 [1..1] Наименование заболевания <dt:name>Ящур</dt:name>
26 ············</dt:relatedDisease>
27 ············<dt:prosperity> dt:ProsperityType [1..1] Статус благополучия:
  • UNDEFINED - не определялся
  • UNKNOWN - неизвестный
  • SAFE - благополучный
  • UNSAFE - неблагополучный
 <dt:prosperity>UNSAFE</dt:prosperity>
28 ············<dt:vaccination> dt:VaccinationType [1..1] Статус применения вакцины:
  • UNDEFINED - неопределенный
  • APPLIED - вакцинация проводится
  • UNVACCINATED - вакцинация не проводится
 <dt:vaccination>APPLIED</dt:vaccination>
29 ·········</dt:fromR13nStatus>
30 ·········<dt:toR13nStatus> dt:RegionalizationStatus [0..1] Статус территории, куда партия направляется (место назначения), согласно регионализации.
31 ············<dt:relatedDisease> dt:AnimalDisease [1..1] Заболевание, по которому назначен статус
32 ···············<bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
33 ···············<bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
34 ···············<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
35 ···············<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
36 ···············<bs:status> bs:VersionStatus [1..1] Статус версии заболевания. <bs:status>100</bs:status>
37 ···············<bs:createDate> xs:DateTime [1..1] Дата создания заболевания. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
38 ···············<bs:updateDate> xs:DateTime [1..1] Дата изменения заболевания. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
39 ···············<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра заболевания. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
40 ···············<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра заболевания. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
41 ···············<dt:name> bs:String255 [1..1] Наименование заболевания <dt:name>Ящур</dt:name>
42 ············</dt:relatedDisease>
43 ············<dt:prosperity> dt:ProsperityType [1..1] Статус благополучия:
  • UNDEFINED - не определялся
  • UNKNOWN - неизвестный
  • SAFE - благополучный
  • UNSAFE - неблагополучный
 <dt:prosperity>UNSAFE</dt:prosperity>
44 ············<dt:vaccination> dt:VaccinationType [1..1] Статус применения вакцины:
  • UNDEFINED - неопределенный
  • APPLIED - вакцинация проводится
  • UNVACCINATED - вакцинация не проводится
 <dt:vaccination>APPLIED</dt:vaccination>
45 ·········</dt:toR13nStatus>
46 ·········<dt:cargoType> dt:SubProduct [0..*] Ветеринарная категория груза, на которую распространяется правило перемещения.
47 ············<bs:uuid> bs:UUID [1..1] Идентификатор версии вида продукции. <bs:uuid>d9d008eb-057a-4cd4-8cb2-d69364318bbe</bs:uuid>
48 ············<bs:guid> bs:UUID [1..1] Глобальный идентификатор вида продукции. <bs:guid>6f5feda1-a3d4-4dfd-8625-de62777a205e</bs:guid>
49 ·········<dt:cargoType>
50 ·········<dt:decision> dt:RegionalizationDecision [0..1] Решение о возможности перемещения груза: перемещение запрещено, перемещение разрешено или перемещение разрешено при обязательном соблюдении условий. <dt:decision>2</dt:decision>
51 ·········<dt:requirement> dt:RegionalizationRequirement [0..*] Требование к перемещению партии в отношении к определенному заболеванию.
52 ············<dt:type> dt:RegionalizationDecision [1..1] Вид требования:
  • Перемещение запрещено, перемещение разрешено или перемещение разрешено при обязательном соблюдении условий.
 <dt:type>2</dt:type>
53 ············<dt:conditionGroup> dt:RegionalizationConditionGroup [1..*] Группа условий регионализации, соблюдаемых при перевозке продукции.
  • Имеет смысл, если тип требования `type` имеет значение 2 (перемещение разрешено при обязательном соблюдении условий). В этом случае требование считается выполненным, если выполнена одна из альтернативных групп условий `conditionGroup`. См. условие выполнения группы в описании типа `dt:RegionalizationConditionGroup`.
54 ···············<dt:condition> dt:RegionalizationCondition [1..*] Условие регионализации, соблюдаемое при перевозке груза
55 ··················<bs:uuid> bs:UUID [1..1] Идентификатор версии условия <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
56 ··················<bs:guid> bs:UUID [1..1] Глобальный идентификатор условия <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
57 ··················<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
58 ··················<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
59 ··················<bs:status> bs:VersionStatus [1..1] Статус версии условия <bs:status>100</bs:status>
60 ··················<bs:createDate> xs:DateTime [1..1] Дата создания условия <bs:createDate>2017-07-07T12:00:00</bs:createDate>
61 ··················<bs:updateDate> xs:DateTime [1..1] Дата изменения условия <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
62 ··················<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
63 ··················<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
64 ··················<bs:referenceNumber> bs:Identifier [1..1] Номер условия. <dt:referenceNumber>10</dt:referenceNumber>
65 ··················<bs:text> bs:Text [1..1] Формулировка условия. <dt:text>Продукты переработки получены из продуктов убоя птицы, соответствующей пунктам 1, 6, 29 и 32.</dt:text>
66 ··················<bs:strict> xs:boolean [1..1] Обязательность соблюдения условия. <dt:strict>true</dt:strict>
67 ··················<dt:relatedDisease> dt:AnimalDisease [1..*] Заболевание, к которому относится данное условие.
68 ·····················<bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания. <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
69 ·····················<bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания. <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
70 ·····················<bs:active> xs:boolean [1..1] Является ли запись активной:
  • true - запись активна;
  • false - запись не активна.
 <bs:active>true</bs:active>
71 ·····················<bs:last> xs:boolean [1..1] Является ли версия записи последней:
  • true - да;
  • false - нет.
 <bs:last>true</bs:last>
72 ·····················<bs:status> bs:VersionStatus [1..1] Статус версии заболевания. <bs:status>100</bs:status>
73 ·····················<bs:createDate> xs:DateTime [1..1] Дата создания заболевания. <bs:createDate>2017-07-07T12:00:00</bs:createDate>
74 ·····················<bs:updateDate> xs:DateTime [1..1] Дата изменения заболевания. <bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
75 ·····················<bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра заболевания. <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
76 ·····················<bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра заболевания. <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
77 ·····················<dt:name> bs:String255 [1..1] Наименование заболевания <dt:name>Ящур</dt:name>
78 ··················</dt:relatedDisease>
79 ···············</dt:condition>
80 ············</dt:conditionGroup>
81 ·········</dt:requirement>
82 ······</vd:rule>
83 ···</dt:r13nShippingRuleList>
84 </ws:getActualR13nShippingRuleListResponse>

Описание ошибок

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

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

Получение списка статусов регионализации Ростовской области по болезни "Грипп птиц". 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getActualR13nRegionStatusListRequest>
         <dt:disease>
             <bs:guid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:guid>
         </dt:disease>
         <dt:r13nZone>
            <dt:region>
               <bs:guid>f10763dc-63e3-48db-83e1-9c566fe3092b</bs:guid>
            </dt:region>
         </dt:r13nZone>
      </ws:getActualR13nRegionStatusListRequest>
   </soapenv:Body>
</soapenv:Envelope>



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