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

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


==Спецификация запроса==
==Спецификация запроса==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<exc:getPreExportVetDocumentListRequest>'''}}
|
|
| 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|'''</{{color|#660e7a|dt:}}processID>'''}}
|
|
| style="width:52em;"|
|-
|004
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}seqNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}seqNumber>'''}}
|
|
| style="width:52em;"|
|-
|005
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}businessEntity>'''}}
|[[BusinessEntity_v2.0|dt:BusinessEntity]]
|
| 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]]
|
| 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]]
|
| 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]]
|
| 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]]
|
| 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]]
|
| 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]]
|
| 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|'''</exc:metadata>'''}}
|
|
| style="width:52em;"|
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
|[[ListOptions|bs:ListOptions]]
|
| style="width:52em;"| Параметры запрашиваемого списка
|-
|016
|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]
|
| style="width:52em;"| Максимальное запрашиваемое количество объектов в списке.
* По умолчанию значение 100;
* Максимально возможное значение 1000.
|-
|017
|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]
|
| style="width:52em;"| Номер элемента, по которому осуществляется смещение первого элемента списка.
* По умолчанию значение 0.
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
|
|
| style="width:52em;"|
|-
|019
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}consignorEnterprise>'''}}
|[[Enterprise_v2.0|dt:Enterprise]]
|
| style="width:52em;"| Сведения о площадке-отправителе
|-
|020
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|
| style="width:52em;"| Глобальный идентификатор записи
|-
|021
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}consignorEnterprise>'''}}
|
|
| style="width:52em;"|
|-
|022
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}consigneeEnterprise>'''}}
|
|
| style="width:52em;"| Сведения о площадке-получателе
|-
|023
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|
| style="width:52em;"| Глобальный идентификатор записи
|-
|024
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}consigneeEnterprise>'''}}
|
|
| style="width:52em;"|
|-
|025
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}subProduct>'''}}
|
|
| 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]]
|
| 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|'''<{{color|#660e7a|dt:}}producerEnterprise>'''}}
|
|
| style="width:52em;"| Сведения о производителе
|-
|029
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|[[UUID|bs:UUID]]
|
| style="width:52em;"| Глобальный идентификатор записи
|-
|030
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}producerEnterprise>'''}}
|
|
| style="width:52em;"|
|-
|031
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}dateOfProduction>'''}}
|[[DateInterval|bs:DateInterval]]
|
| style="width:52em;"| Сведения о дате производства
|-
|032
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}beginDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}beginDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
|
| style="width:52em;"| Дата начала интервала
|-
|033
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}endDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}endDate>'''}}
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
|
| style="width:52em;"| Дата окончания интервала
|-
|034
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}dateOfProduction>'''}}
|
|
| style="width:52em;"|
|-
|035
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</exc:getPreExportVetDocumentListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}

Версия 02:50, 8 сентября 2021

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

Операция GetPreExportVetDocumentList предназначена для получения списка предэкспортных ВСД на конкретную партию продукции.

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

Пространство имён (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:getPreExportVetDocumentListRequest>
002 ·········<exc:metadata> Метаданные запроса
003 ············<dt:processID>?</dt:processID>
004 ············<dt:seqNumber>?</dt:seqNumber>
005 ············<dt:businessEntity> dt:BusinessEntity Сведения о хозяйствующем субъекте
006 ···············<bs:guid>?</bs:guid> bs:UUID Глобальный идентификатор записи
007 ···············<dt:inn>?</dt:inn> bs:String255 Идентификационный номер ХС (ИНН, БИН или ИИН)
008 ············</dt:businessEntity>
009 ············<vd:user> vd:User Сведения о пользователе организации/учреждения
010 ···············<bs:uuid>?</bs:uuid> bs:UUID Уникальный идентификатор версии записи
011 ···············<vd:login>?</vd:login> xs:NCName Имя пользователя в системе Ветис
012 ···············<vd:snils>?</vd:snils> vd:SNILSType СНИЛС пользователя
013 ············</vd:user>
014 ·········</exc:metadata>
015 ·········<bs:listOptions> bs:ListOptions Параметры запрашиваемого списка
016 ············<bs:count>?</bs:count> xs:nonNegativeInteger Максимальное запрашиваемое количество объектов в списке.
  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
017 ············<bs:offset>?</bs:offset> xs:nonNegativeInteger Номер элемента, по которому осуществляется смещение первого элемента списка.
  • По умолчанию значение 0.
018 ·········</bs:listOptions>
019 ·········<dt:consignorEnterprise> dt:Enterprise Сведения о площадке-отправителе
020 ············<bs:guid>?</bs:guid> bs:UUID Глобальный идентификатор записи
021 ·········</dt:consignorEnterprise>
022 ·········<dt:consigneeEnterprise> Сведения о площадке-получателе
023 ············<bs:guid>?</bs:guid> bs:UUID Глобальный идентификатор записи
024 ·········<dt:consigneeEnterprise>
025 ·········<dt:subProduct> Сведения о виде продукции
026 ············<bs:guid>?</bs:guid> bs:UUID Глобальный идентификатор записи
027 ·········</dt:subProduct>
028 ·········<dt:producerEnterprise> Сведения о производителе
029 ············<bs:guid>?</bs:guid> bs:UUID Глобальный идентификатор записи
030 ·········</dt:producerEnterprise>
031 ·········<dt:dateOfProduction> bs:DateInterval Сведения о дате производства
032 ············<bs:beginDate>?</bs:beginDate> xs:dateTime Дата начала интервала
033 ············<bs:endDate>?</bs:endDate> xs:dateTime Дата окончания интервала
034 ·········</dt:dateOfProduction>
035 </exc:getPreExportVetDocumentListRequest>
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetPreExportVetDocumentList:v2.0&oldid=32671