GetR13nConditionList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(не показана 1 промежуточная версия этого же участника) | |||
Строка 24: | Строка 24: | ||
===Входные данные=== | ===Входные данные=== | ||
* параметры выводимого списка; | * параметры выводимого списка; | ||
* (опционально) глобальный идентификатор заболевания. | |||
===Выходные данные=== | ===Выходные данные=== | ||
Строка 58: | Строка 59: | ||
* По умолчанию значение 100; | * По умолчанию значение 100; | ||
* Максимально возможное значение 1000. | * Максимально возможное значение 1000. | ||
|style="font-family: Courier;" | | |style="font-family: Courier;" |<bs:count>10</bs:count> | ||
|- | |- | ||
|4 | |4 | ||
Строка 66: | Строка 67: | ||
|Номер элемента, по которому осуществляется смещение первого элемента списка. | |Номер элемента, по которому осуществляется смещение первого элемента списка. | ||
* По умолчанию значение 0. | * По умолчанию значение 0. | ||
|style="font-family: Courier;" | | |style="font-family: Courier;" |<bs:offset>2</bs:offset> | ||
|- | |- | ||
|5 | |5 | ||
Строка 87: | Строка 88: | ||
|[1..1] | |[1..1] | ||
|Глобальный идентификатор заболевания. | |Глобальный идентификатор заболевания. | ||
|style="font-family: Courier;" | | |style="font-family: Courier;" |<bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid> | ||
|- | |- | ||
|8 | |8 |
Текущая версия на 11:14, 31 октября 2017
Общие сведения
Операция GetR13nConditionList предназначена для получения списка условий перемещения грузов по правилам регионализации. В список попадают только актуальные записи (active=true). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка условий, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- (опционально) глобальный идентификатор заболевания.
Выходные данные
- список условий перемещения грузов.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getR13nConditionListRequest> | ||||
2 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. | |
3 | ······<bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
<bs:count>10</bs:count> |
4 | ······<bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
<bs:offset>2</bs:offset> |
5 | ···</bs:listOptions> | ||||
6 | ···<dt:disease> | dt:AnimalDisease | [0..1] | (Опционально) Заболевание, к которому относятся запрашиваемые условия перемещения груза. | |
7 | ······<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор заболевания. | <bs:guid>3aa0c3ce-8d01-4779-bfb7-df7f234cf86f</bs:guid> |
8 | ···</dt:disease> | ||||
9 | </ws:getR13nConditionListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getR13nConditionListResponse> | ||||
2 | ···<dt:r13nConditionList count="100" total="539" offset="0"> | dt:RegionalizationConditionList | [1..1] | Тип, описывающий список условий перемещения.
|
|
3 | ······<dt:condition> | dt:RegionalizationCondition | [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] | Является ли запись о условии регионализации активной:
|
<bs:active>true</bs:active> |
7 | ·········<bs:last> | xs:boolean | [1..1] | Последняя версия условия регионализации:
|
<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] | Номер условия. | <dt:referenceNumber>6</dt:referenceNumber> |
14 | ·········<bs:text> | bs:Text | [0..1] | Формулировка условия. | <dt:text>Формулировка условия</dt:text> |
15 | ·········<bs:strict> | xs:boolean | [0..1] | Обязательность соблюдения условия. | <dt:strict>true</dt:strict> |
16 | ·········<dt:relatedDisease> | dt:AnimalDisease | [0..*] | Заболевание, к которому относится данное условие. | |
17 | ············<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии заболевания. | <bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> |
18 | ············<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор заболевания. | <bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid> |
19 | ············<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
20 | ············<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
21 | ············<bs:status> | bs:VersionStatus | [1..1] | Статус версии заболевания. | <bs:status>100</bs:status> |
22 | ············<bs:createDate> | xs:DateTime | [1..1] | Дата создания заболевания. | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
23 | ············<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения заболевания. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
24 | ············<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи реестра заболевания. | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
25 | ············<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи реестра заболевания. | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
26 | ············<dt:name> | bs:String255 | [1..1] | Наименование заболевания | <dt:name>Ящур</dt:name> |
27 | ·········</dt:relatedDisease> | ||||
28 | ······</dt:condition> | ||||
29 | ···</dt:r13nConditionList> | ||||
30 | </ws:getR13nConditionListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
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:getR13nConditionListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
<dt:disease>
<bs:guid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:guid>
</dt:disease>
</ws:getR13nConditionListRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
<SOAP-ENV:Body xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<rdef:getR13nConditionListResponse xmlns:rdef="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base">
<dt:r13nConditionList count="3" total="55" offset="0">
<dt:condition>
<bs:uuid>0171bb71-9ce9-46d3-a6de-6df283aec4be</bs:uuid>
<bs:guid>21b14268-3e62-4e1c-9161-5d66b73a1fba</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2017-06-15T10:13:39+03:00</bs:createDate>
<bs:updateDate>2017-06-15T10:13:39+03:00</bs:updateDate>
<dt:referenceNumber>19</dt:referenceNumber>
<dt:text>Товарное яйцо произведено и расфасовано на территории, имеющей зоосанитарный статус, указанный в левом столбце данной строки или более благополучный.</dt:text>
<dt:strict>true</dt:strict>
<dt:relatedDisease>
<bs:uuid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:uuid>
<bs:guid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2017-08-10T00:00:00+03:00</bs:createDate>
<bs:updateDate>2017-08-10T00:00:00+03:00</bs:updateDate>
<dt:name>Грипп птиц</dt:name>
</dt:relatedDisease>
</dt:condition>
<dt:condition>
<bs:uuid>0d156415-3d90-44ea-9ce5-5bebef6724c8</bs:uuid>
<bs:guid>aba35466-0b62-48d4-9f6d-e6114396e4a0</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>200</bs:status>
<bs:createDate>2017-06-15T10:11:15+03:00</bs:createDate>
<bs:updateDate>2017-06-15T10:11:15+03:00</bs:updateDate>
<bs:previous>684d5a64-4444-4bd0-8ff0-65252b6c508a</bs:previous>
<dt:referenceNumber>14</dt:referenceNumber>
<dt:text>Поверхность эмбрионов была подвергнута дезинфекции, обеспечивающей уничтожение вируса гриппа птиц.</dt:text>
<dt:strict>true</dt:strict>
<dt:relatedDisease>
<bs:uuid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:uuid>
<bs:guid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2017-08-10T00:00:00+03:00</bs:createDate>
<bs:updateDate>2017-08-10T00:00:00+03:00</bs:updateDate>
<dt:name>Грипп птиц</dt:name>
</dt:relatedDisease>
</dt:condition>
<dt:condition>
<bs:uuid>0da653bd-9d4c-4c78-8031-b036e5a26690</bs:uuid>
<bs:guid>295186cc-0566-4e2f-afbc-7f1c84204766</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>200</bs:status>
<bs:createDate>2017-06-15T10:05:19+03:00</bs:createDate>
<bs:updateDate>2017-06-15T10:05:19+03:00</bs:updateDate>
<bs:previous>bca327d0-feac-4004-b401-0533027763fd</bs:previous>
<dt:referenceNumber>6</dt:referenceNumber>
<dt:text>Птица содержались изолированно с момента вылупления или минимум 21 день под наблюдением ветеринарного врача и при этом не было выявлено ни каких клинических признаков, характерных для гриппа А птиц.</dt:text>
<dt:strict>true</dt:strict>
<dt:relatedDisease>
<bs:uuid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:uuid>
<bs:guid>91076df2-eea1-11e2-b8ad-8c89a53303ad</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2017-08-10T00:00:00+03:00</bs:createDate>
<bs:updateDate>2017-08-10T00:00:00+03:00</bs:updateDate>
<dt:name>Грипп птиц</dt:name>
</dt:relatedDisease>
</dt:condition>
</dt:r13nConditionList>
</rdef:getR13nConditionListResponse>
</SOAP-ENV:Body>
</soapenv:Envelope>