GetResearchMethodList v2.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
Строка 87: Строка 87:
! Тип
! Тип
! Обязат.
! Обязат.
! Описание
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
|-
|-
|1
|001
|style="font-weight: bold; font-family: Courier;" |<ws:getResearchMethodListResponse>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getResearchMethodListResponse>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|2
|002
|style="font-weight: bold; font-family: Courier;" |···&lt;dt:researchMethodList count="100" total="115" offset="0">
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}researchMethodList {{color|Red|total&#61;}}{{color|#007f15|"2"}} {{color|Red|offset&#61;}}{{color|#007f15|"0"}} {{color|Red|count&#61;}}{{color|#007f15|"2"}}>'''}}
|[[ResearchMethodList_v2.0|dt:ResearchMethodList]]
|[[ResearchMethodList_v2.0|dt:ResearchMethodList]]
|[1..1]
|[1..1]
|Список методов исследования
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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;">
* total - всего записей;
* total - всего записей;
* offset - смещение относительно первого элемента;
* offset - смещение относительно первого элемента;
* count - количество выводимых записей.
* count - количество выводимых записей.</div>
|style="font-family: Courier;" |
</div>
|-
|-
|3
|003
|style="font-weight: bold; font-family: Courier;" |······&lt;dt:researchMethod>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}researchMethod>'''}}
|[[ResearchMethod_v2.0|dt:ResearchMethod]]
|[[ResearchMethod_v2.0|dt:ResearchMethod]]
|[0..*]
|[0..*]
|Метод исследования.
| style="width:52em;"| Метод исследования.
|style="font-family: Courier;" |
|-
|-
|4
|004
|style="font-weight: bold; font-family: Courier;" |·········<bs:uuid>
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[[UUID|bs:UUID]]
|[1..1]
|[1..1]
|Идентификатор версии метода исследования.
| style="width:52em;"| Идентификатор версии метода исследования.
|style="font-family: Courier;" |<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
|-
|-
|5
|005
|style="font-weight: bold; font-family: Courier;" |·········<bs:guid>
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|Глобальный идентификатор метода исследования.
| style="width:52em;"| Глобальный идентификатор метода исследования.
|style="font-family: Courier;" |<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
|-
|-
|6
|006
|style="font-weight: bold; font-family: Courier;" |·········<bs:active>
|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]
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|[1..1]
|Является ли запись активной:
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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 - запись активна;
* true - запись активна;
* false - запись не активна.
* false - запись не активна.</div>
|style="font-family: Courier;" |<bs:active>true</bs:active>
</div>
|-
|-
|7
|007
|style="font-weight: bold; font-family: Courier;" |·········<bs:last>
|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]
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
|[1..1]
|[1..1]
|Является ли версия записи последней:
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" 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 - да;
* true - да;
* false - нет.  
* false - нет. </div>
|style="font-family: Courier;" |<bs:last>true</bs:last>
</div>
|-
|-
|8
|008
|style="font-weight: bold; font-family: Courier;" |·········<bs:status>
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|100}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|[[VersionStatus|bs:VersionStatus]]
|[[VersionStatus|bs:VersionStatus]]
|[1..1]
|[1..1]
|Статус версии метода исследования.
| style="width:52em;"| Статус версии метода исследования.
|style="font-family: Courier;" |<bs:status></bs:status>
|-
|-
|9
|009
|style="font-weight: bold; font-family: Courier;" |·········<bs:createDate>
|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]
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
|[1..1]
|Дата создания метода исследования.
| style="width:52em;"| Дата создания метода исследования.
|style="font-family: Courier;" |<bs:createDate>2017-07-07T12:00:00</bs:createDate>
|-
|-
|10
|010
|style="font-weight: bold; font-family: Courier;" |·········<bs:updateDate>
|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]
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
|[1..1]
|[1..1]
|Дата изменения метода исследования.
| style="width:52em;"| Дата изменения метода исследования.
|style="font-family: Courier;" |<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
|-
|-
|11
|011
|style="font-weight: bold; font-family: Courier;" |·········<bs:previous>
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|[[UUID|bs:UUID]]
|[[UUID|bs:UUID]]
|[0..1]
|[0..1]
|Идентификатор предыдущей версии записи метода исследования.
| style="width:52em;"| Идентификатор предыдущей версии записи метода исследования.
|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
|012
|style="font-weight: bold; font-family: Courier;" |·········&lt;dt:name>
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|Метод 1}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|[[String255|bs:String255]]
|[[String255|bs:String255]]
|[1..1]
|[1..1]
|Наименование метода исследования.
| style="width:52em;"| Наименование метода исследования.
|style="font-family: Courier;" |&lt;dt:name>Метод 1</dt:name>
|-
|-
|14
|013
|style="font-weight: bold; font-family: Courier;" |······</dt:researchMethod>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}researchMethod>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|15
|014
|style="font-weight: bold; font-family: Courier;" |···</dt:researchMethodList>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}researchMethodList>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|16
|015
|style="font-weight: bold; font-family: Courier;" |</ws:getResearchMethodListResponse>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getResearchMethodListResponse>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|}
|}

Текущая версия на 23:18, 10 октября 2020

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

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

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

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

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getResearchMethodListRequest>
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:getResearchMethodListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getResearchMethodListResponse>
002 ···<dt:researchMethodList total="2" offset="0" count="2"> dt:ResearchMethodList [1..1]

Список методов исследования.

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:researchMethod> dt:ResearchMethod [0..*] Метод исследования.
004 ·········<bs:uuid>UUID</bs:uuid> bs:UUID [1..1] Идентификатор версии метода исследования.
005 ·········<bs:guid>GUID</bs:guid> bs:UUID [1..1] Глобальный идентификатор метода исследования.
006 ·········<bs:active>true</bs:active> xs:boolean [1..1]

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

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

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

  • true - да;
  • false - нет.
008 ·········<bs:status>100</bs:status> bs:VersionStatus [1..1] Статус версии метода исследования.
009 ·········<bs:createDate>2017-07-07T12:00:00</bs:createDate> xs:DateTime [1..1] Дата создания метода исследования.
010 ·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> xs:DateTime [1..1] Дата изменения метода исследования.
011 ·········<bs:previous>UUID</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи метода исследования.
012 ·········<dt:name>Метод 1</dt:name> bs:String255 [1..1] Наименование метода исследования.
013 ······</dt:researchMethod>
014 ···</dt:researchMethodList>
015 </ws:getResearchMethodListResponse>

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

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.

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

Источник — http://help.vetrf.ru/index.php?title=GetResearchMethodList_v2.0&oldid=30395