POST api/common/DownloadPrivateAttachment
Request Information
URI Parameters
None.
Body Parameters
DownloadPrivateAttachmentRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"DocumentId": "sample string 1"
}
application/xml, text/xml
Sample:
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="DocumentId" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
DownloadPrivateAttachmentResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| FileResult | FileExportResult |
None. |
|
| ReturnCode | integer |
None. |
|
| MessageCN | string |
None. |
|
| MessageEN | string |
None. |
|
| EventId | globally unique identifier |
None. |
|
| InvitationId | globally unique identifier |
None. |
|
| BankAccountId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"FileResult": {
"FileName": "sample string 1",
"FileType": "sample string 2",
"FileContent": "QEA="
},
"ReturnCode": 1,
"MessageCN": "sample string 2",
"MessageEN": "sample string 3",
"EventId": "e1584a79-0176-4f09-a992-225ab78975d2",
"InvitationId": "07ac09bb-2939-4514-8e4c-268cf9ba56f6",
"BankAccountId": "7270bb95-b2ec-43e0-9d86-bd152453e444"
}
application/xml, text/xml
Sample:
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FileResult.FileName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FileResult.FileType" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FileResult.FileContent[0]" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="FileResult.FileContent[1]" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ReturnCode" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MessageCN" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MessageEN" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="EventId" e1584a79-0176-4f09-a992-225ab78975d2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="InvitationId" 07ac09bb-2939-4514-8e4c-268cf9ba56f6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="BankAccountId" 7270bb95-b2ec-43e0-9d86-bd152453e444 --MultipartDataMediaFormatterBoundary1q2w3e--