Xbase++

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

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

LOCAL nSuccess
LOCAL oHttp
LOCAL oJsonToken
LOCAL oBd1
LOCAL oJson
LOCAL oSbJson
LOCAL cUrl
LOCAL oResp
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cDocumentId
LOCAL cDocumentIdGuid
LOCAL cName
LOCAL cV_type
LOCAL cUri
LOCAL cOrder
LOCAL cContainsPdfFormFields
LOCAL cTemplateRequired
LOCAL cAuthoritativeCopy
LOCAL cEnvelopeId
LOCAL i
LOCAL nCount_i

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

//  Load a previously obtained OAuth2 access token.
oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/docusign.json")
IF (nSuccess == 0)
    ? oJsonToken:LastErrorText
    oHttp:destroy()
    oJsonToken:destroy()
    RETURN
ENDIF

//  Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
oHttp:AuthToken := oJsonToken: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>"
//  		}
//  	]
//  }

oBd1 := CreateObject("Chilkat.BinData")
nSuccess := oBd1:LoadFile("qa_data/pdf/project_xyz.pdf")

oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("documents[0].documentId", "1")
oJson:UpdateString("documents[0].name", "project_xyz.pdf")
oJson:UpdateString("documents[0].pages", "1")
oJson:UpdateString("documents[0].documentBase64", oBd1:GetEncoded("base64"))

oSbJson := CreateObject("Chilkat.StringBuilder")
oJson:EmitCompact := 0
oJson:EmitSb(oSbJson)

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

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

cUrl := "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpSb("PUT", cUrl, oSbJson, "utf-8", "application/json", oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oJsonToken:destroy()
    oBd1:destroy()
    oJson:destroy()
    oSbJson:destroy()
    oResp:destroy()
    RETURN
ENDIF

oJResp := CreateObject("Chilkat.JsonObject")
oJResp:Load(oResp:BodyStr)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

//  If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oResp:Header
    ? "Failed."
    oHttp:destroy()
    oJsonToken:destroy()
    oBd1:destroy()
    oJson:destroy()
    oSbJson:destroy()
    oResp:destroy()
    oJResp:destroy()
    RETURN
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

cEnvelopeId := oJResp:StringOf("envelopeId")
i := 0
nCount_i := oJResp:SizeOfArray("envelopeDocuments")
DO WHILE i < nCount_i
    oJResp:I := i
    cDocumentId := oJResp:StringOf("envelopeDocuments[i].documentId")
    cDocumentIdGuid := oJResp:StringOf("envelopeDocuments[i].documentIdGuid")
    cName := oJResp:StringOf("envelopeDocuments[i].name")
    cV_type := oJResp:StringOf("envelopeDocuments[i].type")
    cUri := oJResp:StringOf("envelopeDocuments[i].uri")
    cOrder := oJResp:StringOf("envelopeDocuments[i].order")
    cContainsPdfFormFields := oJResp:StringOf("envelopeDocuments[i].containsPdfFormFields")
    cTemplateRequired := oJResp:StringOf("envelopeDocuments[i].templateRequired")
    cAuthoritativeCopy := oJResp:StringOf("envelopeDocuments[i].authoritativeCopy")
    i := i + 1
ENDDO

oHttp:destroy()
oJsonToken:destroy()
oBd1:destroy()
oJson:destroy()
oSbJson:destroy()
oResp:destroy()
oJResp:destroy()