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

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


==Спецификация запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<exc:getExportVeterinaryPermitListRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<exc:metadata>'''}}
|
|
| style="width:52em;"|
|-
|003
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}processID>'''}}{{color|#131313|?}}{{color|#190dbf|'''</v2:processID>'''}}
|
|[1..1]
| style="width:52em;"|
|-
|004
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}seqNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</v2:seqNumber>'''}}
|
|[1..1]
| style="width:52em;"|
|-
|005
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}businessEntity>'''}}
|[[BusinessEntity_v2.0|dt:BusinessEntity]]
|[1..1]
| style="width:52em;"| Сведения о хозяйствующем субъекте
|-
|006
|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]
| style="width:52em;"| Глобальный идентификатор записи
|-
|007
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}inn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}inn>'''}}
|[[String255|bs:String255]]
|[1..1]
| style="width:52em;"| Идентификационный номер хозяйствующего субъекта
|-
|008
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}businessEntity>'''}}
|
|
| style="width:52em;"|
|-
|009
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|vd:}}user>'''}}
|[[User_v2.0|vd:User]]
|[1..1]
| style="width:52em;"| Сведения о пользователе организации/учреждения
|-
|010
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|[[UUID|bs:UUID]]
|[1..1]
| style="width:52em;"| Уникальный идентификатор версии записи
|-
|011
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|[[NCName_v2.0|xs:NCName]]
|[1..1]
| style="width:52em;"| Имя пользователя в системе Ветис
|-
|012
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|vd:}}snils>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}snils>'''}}
|[[SNILSType_v2.0|vd:SNILSType]]
|[1..1]
| style="width:52em;"| СНИЛС пользователя
|-
|013
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|vd:}}user>'''}}
|
|
| style="width:52em;"|
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|[[ListOptions|bs:ListOptions]]
|[0..1]
| style="width:52em;"| Параметры запрашиваемого списка
|-
|015
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|?}}{{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>
|-
|016
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|?}}{{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>
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}consignorEnterprise>'''}}
|[[Enterprise_v2.0|dt:Enterprise]]
|[1..1]
| style="width:52em;"|
|-
|019
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|[0..1]
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}}
|
|[1..1]
| style="width:52em;"|
|-
|021
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|[[Region_v2.0|dt:Region]]
|[1..1]
| style="width:52em;"|
|-
|022
|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]
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|
|
| style="width:52em;"|
|-
|024
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}address>'''}}
|
|
| style="width:52em;"|
|-
|025
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProduct>'''}}
|
|[1..1]
| style="width:52em;"|
|-
|026
|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]
| style="width:52em;"|
|-
|027
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}subProduct>'''}}
|
|
| style="width:52em;"|
|-
|028
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<exc:permitYear>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:permitYear>'''}}
|[[Year_v2.0|dt:Year]]
|[1..1]
| style="width:52em;"|
|-
|029
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<exc:importCountry>'''}}
|[[Country_v2.0|dt:Country]]
|[1..1]
| style="width:52em;"| Сведения о стране-импортере
|-
|030
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|BY}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|[[Code_v2.0|dt:Code]]
|[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;">
* двухбуквенный код страны, соответствующий стандарту ISO 3166-1. В качестве кода используются буквы латинского алфавита.
</div>
</div>
|-
|031
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</exc:importCountry>'''}}
|
|
| style="width:52em;"|
|-
|032
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</exc:getExportVeterinaryPermitListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}

Версия 03:46, 8 сентября 2021

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

Операция GetExportVeterinaryPermitList предназначена для получения списка действующих ветеринарных разрешений, выданных хозяйствующему субъекту.

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

Пространство имён (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 <exc:getExportVeterinaryPermitListRequest>
002 ···<exc:metadata>
003 ············<dt:processID>?</v2:processID> [1..1]
004 ············<dt:seqNumber>?</v2:seqNumber> [1..1]
005 ············<dt:businessEntity> dt:BusinessEntity [1..1] Сведения о хозяйствующем субъекте
006 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
007 ···············<dt:inn>?</dt:inn> bs:String255 [1..1] Идентификационный номер хозяйствующего субъекта
008 ············</dt:businessEntity>
009 ············<vd:user> vd:User [1..1] Сведения о пользователе организации/учреждения
010 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
011 ···············<vd:login>?</vd:login> xs:NCName [1..1] Имя пользователя в системе Ветис
012 ···············<vd:snils>?</vd:snils> vd:SNILSType [1..1] СНИЛС пользователя
013 ············</vd:user>
014 ·········<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
015 ············<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке.

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
016 ············<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка.

  • По умолчанию значение 0.
017 ·········</bs:listOptions>
018 ·········<dt:consignorEnterprise> dt:Enterprise [1..1]
019 ············<bs:guid>?</bs:guid> bs:UUID [0..1]
020 ············<dt:address> [1..1]
021 ···············<dt:region> dt:Region [1..1]
022 ··················<bs:guid>?</bs:guid> bs:UUID [1..1]
023 ···············</dt:region>
024 ············</dt:address>
025 ·········<dt:subProduct> [1..1]
026 ············<bs:guid>?</bs:guid> bs:UUID [1..1]
027 ·········</dt:subProduct>
028 ·········<exc:permitYear>?</exc:permitYear> dt:Year [1..1]
029 ·········<exc:importCountry> dt:Country [1..1] Сведения о стране-импортере
030 ············<dt:code>BY</dt:code> dt:Code [1..1]

Код страны.

  • двухбуквенный код страны, соответствующий стандарту ISO 3166-1. В качестве кода используются буквы латинского алфавита.
031 ·········</exc:importCountry>
032 </exc:getExportVeterinaryPermitListRequest>