GetDiseaseByGuid v2.0

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

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

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

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

  • глобальный уникальный идентификатор болезни.

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

  • данные о болезни.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getDiseaseByGuidRequest>
002 ···<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания
003 </ws:getDiseaseByGuidRequest>

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getDiseaseByGuidResponse>
002 ···<dt:disease> dt:AnimalDisease [1..1] Заболевание.
003 ······<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии заболевания.
004 ······<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор заболевания.
005 ······<bs:active>true</bs:active> xs:boolean [1..1]

Описывает является ли запись активной.

  • true - запись активна;
  • false - запись не активна.
006 ······<bs:last>true</bs:last> xs:boolean [1..1]

Описывает является ли версия записи последней.

  • true - да;
  • false - нет.
007 ······<bs:status>100</bs:status> bs:VersionStatus [1..1] Статус версии заболевания.
008 ······<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания заболевания.
009 ······<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения заболевания.
010 ······<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра заболевания.
011 ······<dt:name>Ящур</dt:name> bs:String255 [1..1] Наименование заболевания
012 ···</dt:disease>
013 </ws:getDiseaseByGuidResponse>
Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
EntityNotFoundFault Объект с заданными параметрами не найден в базе.

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

Получение болезни по глобальному идентификатору.

<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:getDiseaseByGuidRequest>
         <bs:guid>28ebe838-951a-44a4-8921-19b9ff521658</bs:guid>
      </ws:getDiseaseByGuidRequest>
   </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:getDiseaseByGuidResponse 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: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>
      </v2:getDiseaseByGuidResponse>
   </SOAP-ENV:Body>
</soapenv:Envelope>