GetDiseaseChangesList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 255: | Строка 255: | ||
==Пример запроса== | ==Пример запроса== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Запрос списка | Запрос списка болезней, измененных за период с 01.01.2017 по текущий день. Вывод первых трёх элементов без смещения. | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<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"> | |||
<soapenv:Header/> | |||
<soapenv:Body> | |||
<ws:getDiseaseChangesListRequest> | |||
<bs:listOptions> | |||
<bs:count>3</bs:count> | |||
<bs:offset>0</bs:offset> | |||
</bs:listOptions> | |||
<bs:updateDateInterval> | |||
<bs:beginDate>2017-01-01T00:00:00</bs:beginDate> | |||
</bs:updateDateInterval> | |||
</ws:getDiseaseChangesListRequest> | |||
</soapenv:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
| Строка 267: | Строка 280: | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<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/"> | |||
<v2:getDiseaseChangesListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2"> | |||
<dt:diseaseList count="3" total="115" offset="0"> | |||
<dt:disease> | |||
<bs:uuid>0508d7e7-71ae-4da3-96c8-88d7a68a758f</bs:uuid> | |||
<bs:guid>0508d7e7-71ae-4da3-96c8-88d7a68a758f</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:disease> | |||
<dt:disease> | |||
<bs:uuid>28ebe838-951a-44a4-8921-19b9ff521658</bs:uuid> | |||
<bs:guid>28ebe838-951a-44a4-8921-19b9ff521658</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:disease> | |||
<dt:disease> | |||
<bs:uuid>9101e3df-eea1-11e2-b8ad-8c89a53303ad</bs:uuid> | |||
<bs:guid>9101e3df-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:disease> | |||
</dt:diseaseList> | |||
</v2:getDiseaseChangesListResponse> | |||
</SOAP-ENV:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
</div> | </div> | ||
<br /> | |||
[[Category:Ветис.API]] | [[Category:Ветис.API]] | ||
[[Category:DictionaryService]] | [[Category:DictionaryService]] | ||
Версия 11:23, 30 октября 2017
Общие сведения
Операция GetDiseaseChangesList предназначена для получения списка изменённых записей о болезнях за период времени. В список попадают записи, дата изменения которых попадает в интервал, указанный в запросе. Записи в списке могут быть не последними и/или не актуальными (last=false, active=false). Выполнение операции заканчивается либо возвратом списка болезней, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
- интервал дат, за за который запрашиваются изменения.
Выходные данные
- список записей о болезнях, изменененных за указанный период времени.
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getDiseaseChangesListRequest> | ||||
| 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 | ···<bs:updateDateInterval> | bs:DataInterval | [1..1] | Интервал времени обновления. В список попадают все записи, дата обновлений которых попадает в указанный интервал. | |
| 7 | ······<bs:beginDate> | xs:dateTime | [1..1] | Начало временного интервала. | <bs:beginDate>2017-07-07T00:00:00</bs:beginDate> |
| 8 | ······<bs:endDate> | xs:dateTime | [0..1] | Конец временного интервала. | <bs:endDate>2017-07-25T00:00:00</bs:endDate> |
| 9 | ···</bs:updateDateInterval> | ||||
| 10 | </ws:getDiseaseChangesListRequest> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getDiseaseChangesListResponse> | ||||
| 2 | ···<dt:diseaseList count="100" total="115" offset="0"> | dt:AnimalDiseaseList | [1..1] | Список заболеваний
|
|
| 3 | ······<dt:disease> | dt:AnimalDisease | [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>100</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>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
| 12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи реестра заболевания. | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
| 13 | ·········<dt:name> | bs:String255 | [1..1] | Наименование заболевания | <dt:name>Ящур</dt:name> |
| 14 | ······</dt:disease> | ||||
| 15 | ···</dt:diseaseList> | ||||
| 16 | </ws:getDiseaseChangesListResponse> |
Описание ошибок
| Ошибка | Описание |
|---|---|
| InternalServiceFault | Внутренняя ошибка сервиса. |
| IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
| OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос списка болезней, измененных за период с 01.01.2017 по текущий день. Вывод первых трёх элементов без смещения.
<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">
<soapenv:Header/>
<soapenv:Body>
<ws:getDiseaseChangesListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
<bs:updateDateInterval>
<bs:beginDate>2017-01-01T00:00:00</bs:beginDate>
</bs:updateDateInterval>
</ws:getDiseaseChangesListRequest>
</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/">
<v2:getDiseaseChangesListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
<dt:diseaseList count="3" total="115" offset="0">
<dt:disease>
<bs:uuid>0508d7e7-71ae-4da3-96c8-88d7a68a758f</bs:uuid>
<bs:guid>0508d7e7-71ae-4da3-96c8-88d7a68a758f</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:disease>
<dt:disease>
<bs:uuid>28ebe838-951a-44a4-8921-19b9ff521658</bs:uuid>
<bs:guid>28ebe838-951a-44a4-8921-19b9ff521658</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:disease>
<dt:disease>
<bs:uuid>9101e3df-eea1-11e2-b8ad-8c89a53303ad</bs:uuid>
<bs:guid>9101e3df-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:disease>
</dt:diseaseList>
</v2:getDiseaseChangesListResponse>
</SOAP-ENV:Body>
</soapenv:Envelope>
