GetDiseaseByGuid v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetDiseaseByGuid''' предназначена для поиска наименования болезни п…») |
|||
(не показано 8 промежуточных версий этого же участника) | |||
Строка 23: | Строка 23: | ||
* данные о болезни. | * данные о болезни. | ||
== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getDiseaseByGuidRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор заболевания | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getDiseaseByGuidRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} | |||
== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getDiseaseByGuidResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}disease>'''}} | |||
|[[AnimalDisease_v2.0|dt:AnimalDisease]] | |||
|[1..1] | |||
| style="width:52em;"| Заболевание. | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Идентификатор версии заболевания. | |||
|- | |||
|004 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор заболевания. | |||
|- | |||
|005 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">Описывает является ли запись активной. | |||
</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* true - запись активна; | |||
* false - запись не активна.</div> | |||
</div> | |||
|- | |||
|006 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">Описывает является ли версия записи последней. | |||
</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* true - да; | |||
* false - нет. </div> | |||
</div> | |||
|- | |||
|007 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|100}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}} | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
| style="width:52em;"| Статус версии заболевания. | |||
|- | |||
|008 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
| style="width:52em;"| Дата создания заболевания. | |||
|- | |||
|009 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
| style="width:52em;"| Дата изменения заболевания. | |||
|- | |||
|010 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
| style="width:52em;"| Идентификатор предыдущей версии записи реестра заболевания. | |||
|- | |||
|011 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|Ящур}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
| style="width:52em;"| Наименование заболевания | |||
|- | |||
|012 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}disease>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|013 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getDiseaseByGuidResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
==Описание ошибок== | ==Описание ошибок== | ||
Строка 40: | Строка 163: | ||
==Пример запроса== | ==Пример запроса== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Получение болезни по глобальному идентификатору. | |||
<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:getDiseaseByGuidRequest> | |||
<bs:guid>28ebe838-951a-44a4-8921-19b9ff521658</bs:guid> | |||
</ws:getDiseaseByGuidRequest> | |||
</soapenv:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
Строка 49: | Строка 179: | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Ответ на запрос. | |||
<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: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> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> |
Текущая версия на 22:43, 10 октября 2020
Общие сведения
Операция 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] | Описывает является ли запись активной.
|
006 | ······<bs:last>true</bs:last> | xs:boolean | [1..1] | Описывает является ли версия записи последней.
|
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>