RMail API

Back to Document

POST api/V1/Document/UploadLocalDocument

This method is used for uploading document from Local Machine.

Prerequisites

Lorem ipsum

Steps to follow-:

1. Initialize Envelope – using following url

Request Information

Lorem ipsum

URI Parameters

None.

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

Name Description Type Additional information
FileName Name of the file which is to be uploaded. string None.
EnvelopeId This will set Envelope Id to which the document will be uploaded. GUID None.
DocumentBase64Data This will set file data in the base 64 format. string None.
EnvelopeStage This will identify envelope is in which stage – InitializeEnvelope/PrepareEnvelope/InitializeDraft/PrepreaDraft/InitializeTemplate/EditTemplate etc. string None.

Request Formats

application/json, text/json
Sample:
{
"FileName": "sample string 1",
"EnvelopeId": "00000000-0000-0000-0000-000000000000",
"DocumentBase64Data": "sample string 3",
"EnvelopeStage": "sample string 4"
}
application/xml, text/xml
Sample:
<UploadLocalDocument xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<FileName>sample string 1</FileName>
<EnvelopeId>00000000-0000-0000-0000-000000000000</EnvelopeId>
<DocumentBase64Data>sample string 3</DocumentBase64Data>
<EnvelopeStage>sample string 4</EnvelopeStage>
</UploadLocalDocument>

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
Message

This will return response message for corresponding status code. string None
EnvelopeId This will return Envelope Id. GUID None
DocumentId This will return Document Id . GUID None
FileName This will return File Name . string None

Response Formats

application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"EnvelopeId": "00000000-0000-0000-0000-000000000000",
"DocumentId": "00000000-0000-0000-0000-000000000000",
"FileName": "sample string 5"
}
application/json, text/json
Sample:
<ResponseMessageDocumentWithDocument 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>
<Message>sample string 2</Message>
<EnvelopeId>00000000-0000-0000-0000-000000000000</EnvelopeId>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<FileName>sample string 5</FileName>
</ResponseMessageDocumentWithDocument>

Was this page helpful?