POST api/common/DownloadPrivateAttachment

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DocumentId		string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentId": "sample string 1"
}

application/xml, text/xml

Sample:

<DownloadPrivateAttachmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DeloitteEvent.DataModel">
  <DocumentId>sample string 1</DocumentId>
</DownloadPrivateAttachmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DownloadPrivateAttachmentResponse

Name	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": "57ca0e0a-ad92-45d7-80f0-cf4929bb0e12",
  "InvitationId": "c31db474-8bdd-4d97-9dd3-2224bf43c849",
  "BankAccountId": "08087fac-9ea0-45e1-9374-b36961bbb4cc"
}

application/xml, text/xml

Sample:

<DownloadPrivateAttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DeloitteEvent.DataModel">
  <BankAccountId>08087fac-9ea0-45e1-9374-b36961bbb4cc</BankAccountId>
  <EventId>57ca0e0a-ad92-45d7-80f0-cf4929bb0e12</EventId>
  <InvitationId>c31db474-8bdd-4d97-9dd3-2224bf43c849</InvitationId>
  <MessageCN>sample string 2</MessageCN>
  <MessageEN>sample string 3</MessageEN>
  <ReturnCode>1</ReturnCode>
  <FileResult>
    <FileContent>QEA=</FileContent>
    <FileName>sample string 1</FileName>
    <FileType>sample string 2</FileType>
  </FileResult>
</DownloadPrivateAttachmentResponse>