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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 30: Строка 30:
! Тип
! Тип
! Обязат.
! Обязат.
! Описание
! Описание (нажмите [...] для отображения дополнительного описания)
! Пример
|-
|-
|1
|001
|style="font-weight: bold; font-family: Courier;" |<ws:getResearchMethodListRequest>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getResearchMethodListRequest>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|2
|002
|style="font-weight: bold; font-family: Courier;" |···<bs:listOptions>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|[[ListOptions|bs:ListOptions]]
|[[ListOptions|bs:ListOptions]]
|[0..1]
|[0..1]
|Параметры запрашиваемого списка.
| style="width:52em;"| Параметры запрашиваемого списка.
|style="font-family: Courier;" |
|-
|-
|3
|003
|style="font-weight: bold; font-family: Courier;" |······<bs:count>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|[0..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;">
* По умолчанию значение 100;
* По умолчанию значение 100;
* Максимально возможное значение 1000.
* Максимально возможное значение 1000.</div>
|style="font-family: Courier;" |<bs:count>10</bs:count>
</div>
|-
|-
|4
|004
|style="font-weight: bold; font-family: Courier;" |······<bs:offset>
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
|[0..1]
|[0..1]
|Номер элемента, по которому осуществляется смещение первого элемента списка.  
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
* По умолчанию значение 0.
<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.  
|style="font-family: Courier;" |<bs:offset>2</bs:offset>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 0.</div>
</div>
|-
|-
|5
|005
|style="font-weight: bold; font-family: Courier;" |···</bs:listOptions>
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
|
|
|
| style="width:52em;"|  
|style="font-family: Courier;" |
|-
|-
|6
|006
|style="font-weight: bold; font-family: Courier;" |</ws:getResearchMethodListRequest>
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getResearchMethodListRequest>'''}}
|
|
|
|
|
|style="font-family: Courier;" |
| style="width:52em;"|  
|-
|-
|}
|}

Версия 23:17, 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-элемента Тип Обязат. Описание Пример
1 <ws:getResearchMethodListResponse>
2 ···<dt:researchMethodList count="100" total="115" offset="0"> dt:ResearchMethodList [1..1] Список методов исследования
  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
3 ······<dt:researchMethod> dt:ResearchMethod [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></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>Метод 1</dt:name>
14 ······</dt:researchMethod>
15 ···</dt:researchMethodList>
16 </ws:getResearchMethodListResponse>

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

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

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