Sample code for 30+ languages & platforms
Visual FoxPro

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope.

Chilkat Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loHttp
LOCAL loJsonToken
LOCAL loBd1
LOCAL loJson
LOCAL loSbJson
LOCAL lcUrl
LOCAL loResp
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcDocumentId
LOCAL lcDocumentIdGuid
LOCAL lcName
LOCAL lcV_type
LOCAL lcUri
LOCAL lcOrder
LOCAL lcContainsPdfFormFields
LOCAL lcTemplateRequired
LOCAL lcAuthoritativeCopy
LOCAL lcEnvelopeId
LOCAL i
LOCAL lnCount_i

lnSuccess = 0

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loHttp = CreateObject('Chilkat.Http')

* Load a previously obtained OAuth2 access token.
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")
IF (lnSuccess = 0) THEN
    ? loJsonToken.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    CANCEL
ENDIF

* Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loHttp.AuthToken = loJsonToken.StringOf("access_token")

* Send the following request.
* Make sure to use your own account ID (obtained from Get Docusign User Account Information)

* PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID>/documents HTTP/1.1
* Expect: 100-continue
* Accept: application/json
* Cache-Control: no-cache
* Authorization: Bearer eyJ0eX...
* Content-Length: ...
* Content-Type: application/json
* 
* {
* 	"documents": [
* 		{
* 		"documentId": "1",
* 		"name": "project_xyz.pdf",
* 		"pages": "1",
* 		"documentBase64": "<insert base64 content here>"
* 		}
* 	]
* }

loBd1 = CreateObject('Chilkat.BinData')
lnSuccess = loBd1.LoadFile("qa_data/pdf/project_xyz.pdf")

loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("documents[0].documentId","1")
loJson.UpdateString("documents[0].name","project_xyz.pdf")
loJson.UpdateString("documents[0].pages","1")
loJson.UpdateString("documents[0].documentBase64",loBd1.GetEncoded("base64"))

loSbJson = CreateObject('Chilkat.StringBuilder')
loJson.EmitCompact = 0
loJson.EmitSb(loSbJson)

loHttp.SetRequestHeader("Expect","100-continue")
loHttp.SetRequestHeader("Cache-Control","no-cache")
loHttp.SetRequestHeader("Accept","application/json")

* Use your own account ID here.
loHttp.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
* Use the envelope ID returned by DocuSign when creating the draft envelope).
loHttp.SetUrlVar("envelopeId","cee4191c-f94e-4089-9d7c-8033685cbc1a")

lcUrl = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpSb("PUT",lcUrl,loSbJson,"utf-8","application/json",loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loBd1
    RELEASE loJson
    RELEASE loSbJson
    RELEASE loResp
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat.JsonObject')
loJResp.Load(loResp.BodyStr)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

* If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loBd1
    RELEASE loJson
    RELEASE loSbJson
    RELEASE loResp
    RELEASE loJResp
    CANCEL
ENDIF

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
*   "envelopeDocuments": [
*     {
*       "documentId": "1",
*       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
*       "name": "project_xyz.pdf",
*       "type": "content",
*       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
*       "order": "3",
*       "containsPdfFormFields": "false",
*       "templateRequired": "false",
*       "authoritativeCopy": "false"
*     }
*   ]
* }

* Sample code for parsing the JSON response...
* Use the following online tool to generate parsing code from sample JSON:
* Generate Parsing Code from JSON

lcEnvelopeId = loJResp.StringOf("envelopeId")
i = 0
lnCount_i = loJResp.SizeOfArray("envelopeDocuments")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcDocumentId = loJResp.StringOf("envelopeDocuments[i].documentId")
    lcDocumentIdGuid = loJResp.StringOf("envelopeDocuments[i].documentIdGuid")
    lcName = loJResp.StringOf("envelopeDocuments[i].name")
    lcV_type = loJResp.StringOf("envelopeDocuments[i].type")
    lcUri = loJResp.StringOf("envelopeDocuments[i].uri")
    lcOrder = loJResp.StringOf("envelopeDocuments[i].order")
    lcContainsPdfFormFields = loJResp.StringOf("envelopeDocuments[i].containsPdfFormFields")
    lcTemplateRequired = loJResp.StringOf("envelopeDocuments[i].templateRequired")
    lcAuthoritativeCopy = loJResp.StringOf("envelopeDocuments[i].authoritativeCopy")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJsonToken
RELEASE loBd1
RELEASE loJson
RELEASE loSbJson
RELEASE loResp
RELEASE loJResp