RMail API

Back to Manage

GET api/V1/Manage/GetDownloadedTransparencyDocument/{envelopeCodeOrEnvelopeId}

This method is used to generate Base64 string for Terminated PDF document.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

Name Description Type ADDITIONAL INFORMATION
envelopeCodeOrEnvelopeId This can either be an Envelope Code or EnvelopeId (guid) of Envelope for which file needs to be downlaod. string Required

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional Information
StatusCode This will return Status Code. HttpStatusCode None.
StatusMessage This will return Status Message. string None
FileName This will return File Name. string None
FilePath This will return File Path. string None
Message This will return response message for corresponding status code. string None
Base64FileData This will return Base64 string for final PDF document. string None
byteArray This will return Bytes of xml doc. Collection of byte
None

Response Formats

application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"FileName": "sample string 2",
"FilePath": "sample string 3",
"Message": "sample string 4",
"Base64FileData": "sample string 5",
"byteArray": "QEA="
}
application/xml, text/xml
Sample:
<ResponseMessageFile xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<StatusCode>Continue</StatusCode>
<StatusMessage>sample string 1</StatusMessage>
<FileName>sample string 2</FileName>
<FilePath>sample string 3</FilePath>
<Message>sample string 4</Message>
<Base64FileData>sample string 5</Base64FileData>
<byteArray>QEA=</byteArray>
</ResponseMessageFile>

Was this page helpful?