Lianja
Lianja
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 Lianja Downloads
llSuccess = .F.
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Load a previously obtained OAuth2 access token.
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")
if (llSuccess = .F.) then
? loJsonToken.LastErrorText
release loHttp
release loJsonToken
return
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)
// 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"
// }]
// }
// }
// ]
// }
loJson = createobject("CkJsonObject")
i = 0
loJson.I = i
loJson.UpdateString("carbonCopies[i].email","support@chilkatsoft.com")
loJson.UpdateString("carbonCopies[i].name","Chilkat Support")
loJson.UpdateString("carbonCopies[i].recipientId","101")
loJson.UpdateNewObject("carbonCopies[i].tabs")
i = 0
loJson.I = i
loJson.UpdateString("signers[i].email","admin@chilkatsoft.com")
loJson.UpdateString("signers[i].name","Chilkat Admin")
loJson.UpdateString("signers[i].recipientId","1")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorString","Please Sign Here")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset","1")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset","0")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits","inches")
i = i + 1
loJson.I = i
loJson.UpdateString("signers[i].email","matt@chilkat.io")
loJson.UpdateString("signers[i].name","Matt")
loJson.UpdateString("signers[i].recipientId","2")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorString","Please Also Sign Here")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset","1")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset","0")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
loJson.UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits","inches")
loSbJson = createobject("CkStringBuilder")
loJson.EmitCompact = .F.
loJson.EmitSb(loSbJson)
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}/recipients"
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpSb("POST",lcUrl,loSbJson,"utf-8","application/json",loResp)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJsonToken
release loJson
release loSbJson
release loResp
return
endif
loJResp = createobject("CkJsonObject")
loJResp.Load(loResp.BodyStr)
loJResp.EmitCompact = .F.
? "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 loJson
release loSbJson
release loResp
release loJResp
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
lcRecipientCount = loJson.StringOf("recipientCount")
i = 0
lnCount_i = loJson.SizeOfArray("signers")
do while i < lnCount_i
loJson.I = i
lcCreationReason = loJson.StringOf("signers[i].creationReason")
lcRequireUploadSignature = loJson.StringOf("signers[i].requireUploadSignature")
lcEmail = loJson.StringOf("signers[i].email")
lcRecipientId = loJson.StringOf("signers[i].recipientId")
lcRequireIdLookup = loJson.StringOf("signers[i].requireIdLookup")
lcRoutingOrder = loJson.StringOf("signers[i].routingOrder")
lcStatus = loJson.StringOf("signers[i].status")
lcCompletedCount = loJson.StringOf("signers[i].completedCount")
lcDeliveryMethod = loJson.StringOf("signers[i].deliveryMethod")
lcRecipientType = loJson.StringOf("signers[i].recipientType")
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("agents")
do while i < lnCount_i
loJson.I = i
// ...
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("editors")
do while i < lnCount_i
loJson.I = i
// ...
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("intermediaries")
do while i < lnCount_i
loJson.I = i
// ...
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("carbonCopies")
do while i < lnCount_i
loJson.I = i
lcEmail = loJson.StringOf("carbonCopies[i].email")
lcRecipientId = loJson.StringOf("carbonCopies[i].recipientId")
lcRequireIdLookup = loJson.StringOf("carbonCopies[i].requireIdLookup")
lcRoutingOrder = loJson.StringOf("carbonCopies[i].routingOrder")
lcStatus = loJson.StringOf("carbonCopies[i].status")
lcCompletedCount = loJson.StringOf("carbonCopies[i].completedCount")
lcDeliveryMethod = loJson.StringOf("carbonCopies[i].deliveryMethod")
lcRecipientType = loJson.StringOf("carbonCopies[i].recipientType")
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("certifiedDeliveries")
do while i < lnCount_i
loJson.I = i
// ...
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("inPersonSigners")
do while i < lnCount_i
loJson.I = i
// ...
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("seals")
do while i < lnCount_i
loJson.I = i
// ...
i = i + 1
enddo
i = 0
lnCount_i = loJson.SizeOfArray("witnesses")
do while i < lnCount_i
loJson.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"
// }
//
release loHttp
release loJsonToken
release loJson
release loSbJson
release loResp
release loJResp