Classic ASP
Classic ASP
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 Classic ASP Downloads
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
success = 0
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
set http = Server.CreateObject("Chilkat.Http")
' Load a previously obtained OAuth2 access token.
set jsonToken = Server.CreateObject("Chilkat.JsonObject")
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( jsonToken.LastErrorText) & "</pre>"
Response.End
End If
' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
http.AuthToken = jsonToken.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"
' }]
' }
' }
' ]
' }
set json = Server.CreateObject("Chilkat.JsonObject")
i = 0
json.I = i
success = json.UpdateString("carbonCopies[i].email","support@chilkatsoft.com")
success = json.UpdateString("carbonCopies[i].name","Chilkat Support")
success = json.UpdateString("carbonCopies[i].recipientId","101")
success = json.UpdateNewObject("carbonCopies[i].tabs")
i = 0
json.I = i
success = json.UpdateString("signers[i].email","admin@chilkatsoft.com")
success = json.UpdateString("signers[i].name","Chilkat Admin")
success = json.UpdateString("signers[i].recipientId","1")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorString","Please Sign Here")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset","1")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset","0")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits","inches")
i = i + 1
json.I = i
success = json.UpdateString("signers[i].email","matt@chilkat.io")
success = json.UpdateString("signers[i].name","Matt")
success = json.UpdateString("signers[i].recipientId","2")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorString","Please Also Sign Here")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorXOffset","1")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorYOffset","0")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent","false")
success = json.UpdateString("signers[i].tabs.signHereTabs[0].anchorUnits","inches")
set sbJson = Server.CreateObject("Chilkat.StringBuilder")
json.EmitCompact = 0
success = json.EmitSb(sbJson)
http.SetRequestHeader "Cache-Control","no-cache"
http.SetRequestHeader "Accept","application/json"
' Use your own account ID here.
success = http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
' Use the envelope ID returned by DocuSign when creating the draft envelope).
success = http.SetUrlVar("envelopeId","cee4191c-f94e-4089-9d7c-8033685cbc1a")
url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients"
set resp = Server.CreateObject("Chilkat.HttpResponse")
success = http.HttpSb("POST",url,sbJson,"utf-8","application/json",resp)
If (success = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.Load(resp.BodyStr)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
' If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
End If
' 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
recipientCount = json.StringOf("recipientCount")
i = 0
count_i = json.SizeOfArray("signers")
Do While i < count_i
json.I = i
creationReason = json.StringOf("signers[i].creationReason")
requireUploadSignature = json.StringOf("signers[i].requireUploadSignature")
email = json.StringOf("signers[i].email")
recipientId = json.StringOf("signers[i].recipientId")
requireIdLookup = json.StringOf("signers[i].requireIdLookup")
routingOrder = json.StringOf("signers[i].routingOrder")
status = json.StringOf("signers[i].status")
completedCount = json.StringOf("signers[i].completedCount")
deliveryMethod = json.StringOf("signers[i].deliveryMethod")
recipientType = json.StringOf("signers[i].recipientType")
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("agents")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("editors")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("intermediaries")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("carbonCopies")
Do While i < count_i
json.I = i
email = json.StringOf("carbonCopies[i].email")
recipientId = json.StringOf("carbonCopies[i].recipientId")
requireIdLookup = json.StringOf("carbonCopies[i].requireIdLookup")
routingOrder = json.StringOf("carbonCopies[i].routingOrder")
status = json.StringOf("carbonCopies[i].status")
completedCount = json.StringOf("carbonCopies[i].completedCount")
deliveryMethod = json.StringOf("carbonCopies[i].deliveryMethod")
recipientType = json.StringOf("carbonCopies[i].recipientType")
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("certifiedDeliveries")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("inPersonSigners")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("seals")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
i = 0
count_i = json.SizeOfArray("witnesses")
Do While i < count_i
json.I = i
' ...
i = i + 1
Loop
' 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"
' }
'
%>
</body>
</html>