Xbase++
Xbase++
DocuSign Add Recipients to a Draft Envelope
See more DocuSign Examples
Demonstrates how to add one or more recipients to a DocuSign draft envelope.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oJsonToken
LOCAL oJson
LOCAL i
LOCAL oSbJson
LOCAL cUrl
LOCAL oResp
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cCreationReason
LOCAL cRequireUploadSignature
LOCAL cEmail
LOCAL cRecipientId
LOCAL cRequireIdLookup
LOCAL cRoutingOrder
LOCAL cStatus
LOCAL cCompletedCount
LOCAL cDeliveryMethod
LOCAL cRecipientType
LOCAL cRecipientCount
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)
// POST https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID>/recipients HTTP/1.1
// Accept: application/json
// Cache-Control: no-cache
// Authorization: Bearer eyJ0eX...
// Content-Length: ...
// Content-Type: application/json
//
// {
// "carbonCopies": [
// {
// "email": "support@chilkatsoft.com",
// "name": "Chilkat Support",
// "recipientId": "101",
// "tabs": {}
// }
// ],
// "signers": [
// {
// "email": "admin@chilkatsoft.com",
// "name": "Chilkat Admin",
// "recipientId": "1",
// "tabs": {
// "signHereTabs": [{
// "anchorString": "Please Sign Here",
// "anchorXOffset": "1",
// "anchorYOffset": "0",
// "anchorIgnoreIfNotPresent": "false",
// "anchorUnits": "inches"
// }]
// }
// },
// {
// "email": "matt@chilkat.io",
// "name": "Matt",
// "recipientId": "2",
// "tabs": {
// "signHereTabs": [{
// "anchorString": "Please Also Sign Here",
// "anchorXOffset": "1",
// "anchorYOffset": "0",
// "anchorIgnoreIfNotPresent": "false",
// "anchorUnits": "inches"
// }]
// }
// }
// ]
// }
oJson := CreateObject("Chilkat.JsonObject")
i := 0
oJson:I := i
oJson:UpdateString("carbonCopies[i].email", "support@chilkatsoft.com")
oJson:UpdateString("carbonCopies[i].name", "Chilkat Support")
oJson:UpdateString("carbonCopies[i].recipientId", "101")
oJson:UpdateNewObject("carbonCopies[i].tabs")
i := 0
oJson:I := i
oJson:UpdateString("signers[i].email", "admin@chilkatsoft.com")
oJson:UpdateString("signers[i].name", "Chilkat Admin")
oJson:UpdateString("signers[i].recipientId", "1")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorString", "Please Sign Here")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset", "1")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset", "0")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits", "inches")
i := i + 1
oJson:I := i
oJson:UpdateString("signers[i].email", "matt@chilkat.io")
oJson:UpdateString("signers[i].name", "Matt")
oJson:UpdateString("signers[i].recipientId", "2")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorString", "Please Also Sign Here")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset", "1")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset", "0")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent", "false")
oJson:UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits", "inches")
oSbJson := CreateObject("Chilkat.StringBuilder")
oJson:EmitCompact := 0
oJson:EmitSb(oSbJson)
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}/recipients"
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpSb("POST", cUrl, oSbJson, "utf-8", "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oJsonToken: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()
oJson:destroy()
oSbJson:destroy()
oResp:destroy()
oJResp:destroy()
RETURN
ENDIF
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "signers": [
// {
// "creationReason": "sender",
// "requireUploadSignature": "false",
// "email": "admin@chilkatsoft.com",
// "recipientId": "1",
// "requireIdLookup": "false",
// "routingOrder": "1",
// "status": "created",
// "completedCount": "0",
// "deliveryMethod": "email",
// "recipientType": "signer"
// },
// {
// "creationReason": "sender",
// "requireUploadSignature": "false",
// "email": "matt@chilkat.io",
// "recipientId": "2",
// "requireIdLookup": "false",
// "routingOrder": "1",
// "status": "created",
// "completedCount": "0",
// "deliveryMethod": "email",
// "recipientType": "signer"
// }
// ],
// "agents": [],
// "editors": [],
// "intermediaries": [],
// "carbonCopies": [
// {
// "email": "support@chilkatsoft.com",
// "recipientId": "101",
// "requireIdLookup": "false",
// "routingOrder": "1",
// "status": "created",
// "completedCount": "0",
// "deliveryMethod": "email",
// "recipientType": "carboncopy"
// }
// ],
// "certifiedDeliveries": [],
// "inPersonSigners": [],
// "seals": [],
// "witnesses": [],
// "recipientCount": "3"
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
cRecipientCount := oJson:StringOf("recipientCount")
i := 0
nCount_i := oJson:SizeOfArray("signers")
DO WHILE i < nCount_i
oJson:I := i
cCreationReason := oJson:StringOf("signers[i].creationReason")
cRequireUploadSignature := oJson:StringOf("signers[i].requireUploadSignature")
cEmail := oJson:StringOf("signers[i].email")
cRecipientId := oJson:StringOf("signers[i].recipientId")
cRequireIdLookup := oJson:StringOf("signers[i].requireIdLookup")
cRoutingOrder := oJson:StringOf("signers[i].routingOrder")
cStatus := oJson:StringOf("signers[i].status")
cCompletedCount := oJson:StringOf("signers[i].completedCount")
cDeliveryMethod := oJson:StringOf("signers[i].deliveryMethod")
cRecipientType := oJson:StringOf("signers[i].recipientType")
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("agents")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("editors")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("intermediaries")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("carbonCopies")
DO WHILE i < nCount_i
oJson:I := i
cEmail := oJson:StringOf("carbonCopies[i].email")
cRecipientId := oJson:StringOf("carbonCopies[i].recipientId")
cRequireIdLookup := oJson:StringOf("carbonCopies[i].requireIdLookup")
cRoutingOrder := oJson:StringOf("carbonCopies[i].routingOrder")
cStatus := oJson:StringOf("carbonCopies[i].status")
cCompletedCount := oJson:StringOf("carbonCopies[i].completedCount")
cDeliveryMethod := oJson:StringOf("carbonCopies[i].deliveryMethod")
cRecipientType := oJson:StringOf("carbonCopies[i].recipientType")
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("certifiedDeliveries")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("inPersonSigners")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("seals")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
i := 0
nCount_i := oJson:SizeOfArray("witnesses")
DO WHILE i < nCount_i
oJson:I := i
// ...
i := i + 1
ENDDO
// If the recipient already exists within the envelope, we would get
// a success (201) response status code, but errors within the JSON response, such as this:
// {
// "signers": [
// {
// "creationReason": "sender",
// "requireUploadSignature": "false",
// "email": "admin@chilkatsoft.com",
// "recipientId": "1",
// "requireIdLookup": "false",
// "routingOrder": "1",
// "status": "error",
// "completedCount": "0",
// "deliveryMethod": "email",
// "errorDetails": {
// "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
// "message": "This recipientId already exists."
// },
// "recipientType": "signer"
// },
// {
// "creationReason": "sender",
// "requireUploadSignature": "false",
// "email": "matt@chilkat.io",
// "recipientId": "2",
// "requireIdLookup": "false",
// "routingOrder": "1",
// "status": "error",
// "completedCount": "0",
// "deliveryMethod": "email",
// "errorDetails": {
// "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
// "message": "This recipientId already exists."
// },
// "recipientType": "signer"
// }
// ],
// "agents": [
// ],
// "editors": [
// ],
// "intermediaries": [
// ],
// "carbonCopies": [
// {
// "email": "support@chilkatsoft.com",
// "recipientId": "101",
// "requireIdLookup": "false",
// "routingOrder": "1",
// "status": "error",
// "completedCount": "0",
// "deliveryMethod": "email",
// "errorDetails": {
// "errorCode": "RECIPIENT_ALREADY_EXISTS_IN_ENVELOPE",
// "message": "This recipientId already exists."
// },
// "recipientType": "carboncopy"
// }
// ],
// "certifiedDeliveries": [
// ],
// "inPersonSigners": [
// ],
// "seals": [
// ],
// "witnesses": [
// ],
// "recipientCount": "3"
// }
//
oHttp:destroy()
oJsonToken:destroy()
oJson:destroy()
oSbJson:destroy()
oResp:destroy()
oJResp:destroy()