PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
Procedure ChilkatExample()
success.i = 0
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Load a previously obtained OAuth2 access token.
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/docusign.json")
If success = 0
Debug CkJsonObject::ckLastErrorText(jsonToken)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(jsonToken)
ProcedureReturn
EndIf
; Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
CkHttp::setCkAuthToken(http, CkJsonObject::ckStringOf(jsonToken,"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"
; }]
; }
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
i.i = 0
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"carbonCopies[i].email","support@chilkatsoft.com")
CkJsonObject::ckUpdateString(json,"carbonCopies[i].name","Chilkat Support")
CkJsonObject::ckUpdateString(json,"carbonCopies[i].recipientId","101")
CkJsonObject::ckUpdateNewObject(json,"carbonCopies[i].tabs")
i = 0
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"signers[i].email","admin@chilkatsoft.com")
CkJsonObject::ckUpdateString(json,"signers[i].name","Chilkat Admin")
CkJsonObject::ckUpdateString(json,"signers[i].recipientId","1")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorString","Please Sign Here")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorXOffset","1")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorYOffset","0")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorUnits","inches")
i = i + 1
CkJsonObject::setCkI(json, i)
CkJsonObject::ckUpdateString(json,"signers[i].email","matt@chilkat.io")
CkJsonObject::ckUpdateString(json,"signers[i].name","Matt")
CkJsonObject::ckUpdateString(json,"signers[i].recipientId","2")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorString","Please Also Sign Here")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorXOffset","1")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorYOffset","0")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
CkJsonObject::ckUpdateString(json,"signers[i].tabs.signHereTabs[0].anchorUnits","inches")
sbJson.i = CkStringBuilder::ckCreate()
If sbJson.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckEmitSb(json,sbJson)
CkHttp::ckSetRequestHeader(http,"Cache-Control","no-cache")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
; Use your own account ID here.
CkHttp::ckSetUrlVar(http,"accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
; Use the envelope ID returned by DocuSign when creating the draft envelope).
CkHttp::ckSetUrlVar(http,"envelopeId","cee4191c-f94e-4089-9d7c-8033685cbc1a")
url.s = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients"
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpSb(http,"POST",url,sbJson,"utf-8","application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(jsonToken)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbJson)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoad(jResp,CkHttpResponse::ckBodyStr(resp))
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
; If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(jsonToken)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbJson)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
creationReason.s
requireUploadSignature.s
email.s
recipientId.s
requireIdLookup.s
routingOrder.s
status.s
completedCount.s
deliveryMethod.s
recipientType.s
recipientCount.s = CkJsonObject::ckStringOf(json,"recipientCount")
i = 0
count_i.i = CkJsonObject::ckSizeOfArray(json,"signers")
While i < count_i
CkJsonObject::setCkI(json, i)
creationReason = CkJsonObject::ckStringOf(json,"signers[i].creationReason")
requireUploadSignature = CkJsonObject::ckStringOf(json,"signers[i].requireUploadSignature")
email = CkJsonObject::ckStringOf(json,"signers[i].email")
recipientId = CkJsonObject::ckStringOf(json,"signers[i].recipientId")
requireIdLookup = CkJsonObject::ckStringOf(json,"signers[i].requireIdLookup")
routingOrder = CkJsonObject::ckStringOf(json,"signers[i].routingOrder")
status = CkJsonObject::ckStringOf(json,"signers[i].status")
completedCount = CkJsonObject::ckStringOf(json,"signers[i].completedCount")
deliveryMethod = CkJsonObject::ckStringOf(json,"signers[i].deliveryMethod")
recipientType = CkJsonObject::ckStringOf(json,"signers[i].recipientType")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"agents")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"editors")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"intermediaries")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"carbonCopies")
While i < count_i
CkJsonObject::setCkI(json, i)
email = CkJsonObject::ckStringOf(json,"carbonCopies[i].email")
recipientId = CkJsonObject::ckStringOf(json,"carbonCopies[i].recipientId")
requireIdLookup = CkJsonObject::ckStringOf(json,"carbonCopies[i].requireIdLookup")
routingOrder = CkJsonObject::ckStringOf(json,"carbonCopies[i].routingOrder")
status = CkJsonObject::ckStringOf(json,"carbonCopies[i].status")
completedCount = CkJsonObject::ckStringOf(json,"carbonCopies[i].completedCount")
deliveryMethod = CkJsonObject::ckStringOf(json,"carbonCopies[i].deliveryMethod")
recipientType = CkJsonObject::ckStringOf(json,"carbonCopies[i].recipientType")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"certifiedDeliveries")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"inPersonSigners")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"seals")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(json,"witnesses")
While i < count_i
CkJsonObject::setCkI(json, i)
; ...
i = i + 1
Wend
; 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"
; }
;
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(jsonToken)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbJson)
CkHttpResponse::ckDispose(resp)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure