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

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


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<def:uploadAttachmentResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<def:attachment>'''}}
|def:ApplicationAttachment
|[1..1]
| style="width:52em;"| Вложение/файл, ассоциированный с заявкой интеграционного шлюза ВетИС.API
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:attachmentId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</def:attachmentId>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор загружаемого вложения
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:uploadStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</def:uploadStatus>'''}}
|def:AttachmentUploadStatus
|[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;">
* UPLOADED - Загружено
* PARTIALLY_UPLOADED - Частично загружено
* REJECTED - Отказано (не загружено)</div>
</div>
|-
|005
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:uploadDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</def:uploadDate>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Дата и время загрузки
|-
|006
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:result>'''}}
|def:AttachmentDataWrapper
|[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;">
* Обязательно при статусах UPLOADED и PARTIALLY_UPLOADED</div>
</div>
|-
|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:fileSize>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:fileSize>'''}}
|xs:nonNegativeInteger
|[1..1]
| style="width:52em;"| Размер файла в байтах
|-
|012
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<exc:referenceId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</exc:referenceId>'''}}
|exc:ExcDocumentFileReference
|[1..1]
| style="width:52em;"| Ссылка или идентификатор файла в хранилище
|-
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</def:includedFile>'''}}
|
|
| style="width:52em;"|
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</def:result>'''}}
|
|
| style="width:52em;"|
|-
|015
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<def:errors>'''}}
|apl:BusinessErrorList
|[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;">
* Обязательно при статусе REJECTED</div>
</div>
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<app:error code&#61;{{color|#007f15|"?"}} {{color|Red|qualifier&#61;}}{{color|#007f15|"?"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</app:error>'''}}
|apl:BusinessError
|[1..*]
| style="width:52em;"| Код и описание ошибки
|-
|017
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</def:errors>'''}}
|
|
| 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:uploadAttachmentResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Версия 18:50, 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>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <def:uploadAttachmentResponse>
002 ···<def:attachment> def:ApplicationAttachment [1..1] Вложение/файл, ассоциированный с заявкой интеграционного шлюза ВетИС.API
003 ······<def:attachmentId>?</def:attachmentId> bs:UUID [1..1] Идентификатор загружаемого вложения
004 ······<def:uploadStatus>?</def:uploadStatus> def:AttachmentUploadStatus [1..1]

Результат загрузки вложения/файла

  • UPLOADED - Загружено
  • PARTIALLY_UPLOADED - Частично загружено
  • REJECTED - Отказано (не загружено)
005 ······<def:uploadDate>?</def:uploadDate> xs:dateTime [1..1] Дата и время загрузки
006 ······<def:result> def:AttachmentDataWrapper [0..1]

Результат успешной или частично успешной загрузки вложения/файлов

  • Обязательно при статусах UPLOADED и PARTIALLY_UPLOADED
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:fileSize>?</exc:fileSize> xs:nonNegativeInteger [1..1] Размер файла в байтах
012 ············<exc:referenceId>?</exc:referenceId> exc:ExcDocumentFileReference [1..1] Ссылка или идентификатор файла в хранилище
013 ·········</def:includedFile>
014 ······</def:result>
015 ······<def:errors> apl:BusinessErrorList [0..1]

Ошибки при загрузке вложения/файлов

  • Обязательно при статусе REJECTED
016 ·········<app:error code="?" qualifier="?">?</app:error> apl:BusinessError [1..*] Код и описание ошибки
017 ······</def:errors>
018 ···</def:attachment>
019 </def:uploadAttachmentResponse>

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