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

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


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<def:uploadAttachmentRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<def:apiKey>'''}}{{color|#131313|?}}{{color|#190dbf|'''</def:apiKey>'''}}
|apl:APIKey
|[1..1]
| style="width:52em;"| API Key
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<def:attachment>'''}}
|def:ApplicationAttachment
|[1..1]
| style="width:52em;"| Вложение/файл, ассоциированный с заявкой интеграционного шлюза ВетИС.API
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:serviceId>'''}}{{color|#131313|exportcenter.service:2.2}}{{color|#190dbf|'''</def:serviceId>'''}}
|xs:Name
|[1..1]
| style="width:52em;"| Идентификатор сервиса
|-
|005
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:issuerId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</def:issuerId>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор заявителя, клиента интеграционного шлюза ВетИС.API
|-
|006
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:data>'''}}
|def:AttachmentDataWrapper
|[1..1]
| style="width:52em;"| Содержимое загружаемого вложения/файлов с поддержкой пакетной загрузки
|-
|007
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<def:includedFile>'''}}
|exc:ExcDocumentFile
|[1..*]
| style="width:52em;"| Содержимое вложенного документа с возможностью передачи открепленной подписи
|-
|008
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:id>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:id>'''}}
|bs:Identifier
|[1..1]
| style="width:52em;"| Идентификатор файла
|-
|009
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:fileName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:fileName>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Название файла
|-
|010
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:mimeCode>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:mimeCode>'''}}
|xs:token
|[1..1]
| style="width:52em;"| MIME-код файла, представленного в бинарном виде
|-
|011
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:encoding>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:encoding>'''}}
|xs:token
|[0..1]
| style="width:52em;"| Кодировка файла, представленного в бинарном виде
|-
|012
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:fileSize>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:fileSize>'''}}
|xs:nonNegativeInteger
|[0..1]
| style="width:52em;"| Размер файла в байтах
|-
|013
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:fileDigest algorithmId&#61;{{color|#007f15|"?"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:fileDigest>'''}}
|exc:ExcFileDigest
|[1..1]
| style="width:52em;"| Хеш-значение для файла в соответствии с указанным алгоритмом
|-
|014
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:binaryData xmime:contentType&#61;{{color|#007f15|"?"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:binaryData>'''}}
|exc:ExcDocumentBinaryData
|[1..1]
| style="width:52em;"| Содержимое файла в формате base64
|-
|015
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:signature>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:signature>'''}}
|exc:ExcDocumentBinaryData
|[0..*]
| style="width:52em;"| Открепленная подпись файла
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</def:includedFile>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</def:data>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</def:attachment>'''}}
|
|
| style="width:52em;"|
|-
|019
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</def:uploadAttachmentRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


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


== Примеры запросов ==
== Примеры запросов ==

Версия 18:47, 10 апреля 2023

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

Операция UploadAttachment предназначена для загрузки файлов в хранилище и получения уникальных идентификаторов (ссылок) на файлы для дальнейшего использования в операциях.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <def:uploadAttachmentRequest>
002 ···<def:apiKey>?</def:apiKey> apl:APIKey [1..1] API Key
003 ···<def:attachment> def:ApplicationAttachment [1..1] Вложение/файл, ассоциированный с заявкой интеграционного шлюза ВетИС.API
004 ······<def:serviceId>exportcenter.service:2.2</def:serviceId> xs:Name [1..1] Идентификатор сервиса
005 ······<def:issuerId>?</def:issuerId> bs:UUID [1..1] Идентификатор заявителя, клиента интеграционного шлюза ВетИС.API
006 ······<def:data> def:AttachmentDataWrapper [1..1] Содержимое загружаемого вложения/файлов с поддержкой пакетной загрузки
007 ·········<def:includedFile> exc:ExcDocumentFile [1..*] Содержимое вложенного документа с возможностью передачи открепленной подписи
008 ············<exc:id>?</exc:id> bs:Identifier [1..1] Идентификатор файла
009 ············<exc:fileName>?</exc:fileName> bs:String255 [1..1] Название файла
010 ············<exc:mimeCode>?</exc:mimeCode> xs:token [1..1] MIME-код файла, представленного в бинарном виде
011 ············<exc:encoding>?</exc:encoding> xs:token [0..1] Кодировка файла, представленного в бинарном виде
012 ············<exc:fileSize>?</exc:fileSize> xs:nonNegativeInteger [0..1] Размер файла в байтах
013 ············<exc:fileDigest algorithmId="?">?</exc:fileDigest> exc:ExcFileDigest [1..1] Хеш-значение для файла в соответствии с указанным алгоритмом
014 ············<exc:binaryData xmime:contentType="?">?</exc:binaryData> exc:ExcDocumentBinaryData [1..1] Содержимое файла в формате base64
015 ············<exc:signature>?</exc:signature> exc:ExcDocumentBinaryData [0..*] Открепленная подпись файла
016 ·········</def:includedFile>
017 ······</def:data>
018 ···</def:attachment>
019 </def:uploadAttachmentRequest>

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

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

Источник — http://help.vetrf.ru/index.php?title=Exportcenter:UploadAttachment:v2.2&oldid=36591