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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Создана пустая страница)
 
Строка 1: Строка 1:
==Общие сведения==


Операция '''GetExportClearancePointList''' предназначена для получения списка актуальных записей о местах оформления электронных ветеринарных сертификатов (active=true, last=true). Поддерживается постраничный вывод.
==Используемые пространства имён==
{| class="wikitable"
|-
! Пространство имён (xmlns) !! XSD-схема, содержащая описание типов
|-
| <nowiki>xmlns:bs="http://api.vetrf.ru/schema/cdm/base"</nowiki>
|| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/base_v2.0.xsd
|-
| <nowiki>xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2"</nowiki>
|| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/registry_ws_definitions_v2.2.xsd
|-
| <nowiki>xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"</nowiki>
|| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/dictionary_v2.2.xsd
|-
|}
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:GetExportClearancePointList>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|[[ListOptions|bs:ListOptions]]
|[0..1]
| style="width:52em;"| Параметры запрашиваемого списка.
|-
|003
|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]
|[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;
* Максимально возможное значение 1000.</div>
</div>
|-
|004
|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]
|[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;">
* По умолчанию значение 0.</div>
</div>
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}}
|
|
| style="width:52em;"|
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|[[Region_v2.0|dt:Region]]
|[1..1]
|
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
|
|-
|010
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:GetExportClearancePointList>'''}}
|
|
| style="width:52em;"|
|-
|}

Версия 00:51, 8 сентября 2021

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

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

Используемые пространства имён

Пространство имён (xmlns) XSD-схема, содержащая описание типов
xmlns:bs="http://api.vetrf.ru/schema/cdm/base" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/base_v2.0.xsd
xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/registry_ws_definitions_v2.2.xsd
xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/dictionary_v2.2.xsd

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:GetExportClearancePointList>
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 ···<dt:address>
007 ······<dt:region>?</dt:region> dt:Region [1..1]
008 ·········<bs:guid>?</bs:guid> bs:UUID [1..1]
010 </ws:GetExportClearancePointList>