GetDiseaseList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 83: | Строка 83: | ||
==Спецификация ответа== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание | |||
! Пример | |||
|- | |||
|1 | |||
|style="font-weight: bold; font-family: Courier;" |<ws:getDiseaseListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|2 | |||
|style="font-weight: bold; font-family: Courier;" |···<dt:diseaseList count="100" total="115" offset="0"> | |||
|[[AnimalDiseaseList_v2.0|dt:AnimalDiseaseList]] | |||
|[1..1] | |||
|Список заболеваний | |||
* total - всего записей; | |||
* offset - смещение относительно первого элемента; | |||
* count - количество выводимых записей. | |||
|style="font-family: Courier;" | | |||
|- | |||
|3 | |||
|style="font-weight: bold; font-family: Courier;" |······<dt:disease> | |||
|[[AnimalDisease_v2.0|dt:AnimalDisease]] | |||
|[0..*] | |||
|Заболевание. | |||
|style="font-family: Courier;" | | |||
|- | |||
|4 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:uuid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Идентификатор версии заболевания. | |||
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid> | |||
|- | |||
|5 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid> | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|Глобальный идентификатор заболевания. | |||
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid> | |||
|- | |||
|6 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:active> | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|Является ли запись активной: | |||
* true - запись активна; | |||
* false - запись не активна. | |||
|style="font-family: Courier;" |<bs:active>true</bs:active> | |||
|- | |||
|7 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:last> | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|Является ли версия записи последней: | |||
* true - да; | |||
* false - нет. | |||
|style="font-family: Courier;" |<bs:last>true</bs:last> | |||
|- | |||
|8 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:status> | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
|Статус версии заболевания. | |||
|style="font-family: Courier;" |<bs:status>100</bs:status> | |||
|- | |||
|9 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:createDate> | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
|Дата создания заболевания. | |||
|style="font-family: Courier;" |<bs:createDate>2017-07-07T12:00:00</bs:createDate> | |||
|- | |||
|10 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:updateDate> | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
|Дата изменения заболевания. | |||
|style="font-family: Courier;" |<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | |||
|- | |||
|11 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:previous> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Идентификатор предыдущей версии записи реестра заболевания. | |||
|style="font-family: Courier;" |<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> | |||
|- | |||
|12 | |||
|style="font-weight: bold; font-family: Courier;" |·········<bs:next> | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
|Идентификатор следующей версии записи реестра заболевания. | |||
|style="font-family: Courier;" |<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> | |||
|- | |||
|13 | |||
|style="font-weight: bold; font-family: Courier;" |·········<dt:name> | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
|Наименование заболевания | |||
|style="font-family: Courier;" |<dt:name>Ящур</dt:name> | |||
|- | |||
|14 | |||
|style="font-weight: bold; font-family: Courier;" |······</dt:disease> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|15 | |||
|style="font-weight: bold; font-family: Courier;" |···</dt:diseaseList> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|16 | |||
|style="font-weight: bold; font-family: Courier;" |</ws:getDiseaseListResponse> | |||
| | |||
| | |||
| | |||
|style="font-family: Courier;" | | |||
|- | |||
|} | |||
==Описание ошибок== | ==Описание ошибок== |
Версия 10:02, 30 октября 2017
Общие сведения
Операция GetDiseaseList предназначена для получения списка актуальных записей о болезнях (active=true, last=true). Выполнение операции заканчивается либо возвратом списка болезней, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка;
Выходные данные
- список актуальных записей о болезнях.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getDiseaseListRequest> | ||||
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 | </ws:getDiseaseListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getDiseaseListResponse> | ||||
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:getDiseaseListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос списка назначений груза, измененных за период с 01.01.2016 по текущий день.
Ответ на запрос.