GetDiseaseList v2.0

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

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

Операция GetDiseaseList предназначена для получения списка актуальных записей о болезнях (active=true, last=true). Выполнение операции заканчивается либо возвратом списка болезней, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

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

  • параметры выводимого списка;

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

  • список актуальных записей о болезнях.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getDiseaseListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
003 ······<bs:count>10</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке.

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
004 ······<bs:offset>2</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка.

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 </ws:getDiseaseListRequest>

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

# Название XML-элемента Тип Обязат. Описание Пример
1 <ws:getDiseaseListResponse>
2 ···<dt:diseaseList count="100" total="115" offset="0"> dt:AnimalDiseaseList [1..1] Список заболеваний
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
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] Является ли запись активной:
  • 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>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 Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос первых трёх элементов справочника болезней.

<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:getDiseaseListRequest>
         <bs:listOptions>
            <bs:count>3</bs:count>
            <bs:offset>0</bs:offset>
         </bs:listOptions>
      </ws:getDiseaseListRequest>
   </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:getDiseaseListResponse 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:getDiseaseListResponse>
   </SOAP-ENV:Body>
</soapenv:Envelope>