POST api/common/DownloadPrivateAttachment

Request Information

URI Parameters

None.

Body Parameters

DownloadPrivateAttachmentRequest
NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "8e0cf8ce-72eb-4e62-9f9d-65fde444de40",
  "InvitationId": "c146b8c2-6d59-44bf-8263-ca7fc47a3b3e",
  "BankAccountId": "82f0cce8-4a08-41c7-bb54-e756715ebf63"
}

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"

8e0cf8ce-72eb-4e62-9f9d-65fde444de40
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="InvitationId"

c146b8c2-6d59-44bf-8263-ca7fc47a3b3e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankAccountId"

82f0cce8-4a08-41c7-bb54-e756715ebf63
--MultipartDataMediaFormatterBoundary1q2w3e--