RMail API

Back to Manage

GET api/V1/Manage/GetFinalSignedPDFDocumentHeader/{envelopeCode}

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

Prerequisites

To be implemented

Steps to follow-:

1. Initialize Envelope – using following url

2. Upload Local Document – using following url

3. Delete Document [Optional] – using following url

4. Prepare Envelope – using following url

5. Add Signature Control [Optional] – using following url

6. Delete Control [Optional] – using following url

7. Clear Controls [Optional] – using following url

8. Send Envelope – using following url

Request Information

Lorem ipsum

URI Parameters

Name Description Type ADDITIONAL INFORMATION
envelopeCodeOrEnvelopeId This is an Envelope Code. 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
Message This will return response message for corresponding status code. string None
PdfInBinary This will return Base64 string for final PDF document. Collection of byte
None

Response Formats

application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"FileName": "sample string 2",
"Message": "sample string 3",
"PdfInBinary": "QEA="
}
application/xml, text/xml
Sample:
<ResponseMessagePDF 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>
<Message>sample string 3</Message>
<PdfInBinary>QEA=</PdfInBinary>
</ResponseMessagePDF>

Was this page helpful?