Unicode C
Unicode C
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 Unicode C Downloads
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttpW http;
HCkJsonObjectW jsonToken;
HCkJsonObjectW json;
int i;
HCkStringBuilderW sbJson;
const wchar_t *url;
HCkHttpResponseW resp;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *creationReason;
const wchar_t *requireUploadSignature;
const wchar_t *email;
const wchar_t *recipientId;
const wchar_t *requireIdLookup;
const wchar_t *routingOrder;
const wchar_t *status;
const wchar_t *completedCount;
const wchar_t *deliveryMethod;
const wchar_t *recipientType;
const wchar_t *recipientCount;
int count_i;
success = FALSE;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Load a previously obtained OAuth2 access token.
jsonToken = CkJsonObjectW_Create();
success = CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/docusign.json");
if (success == FALSE) {
wprintf(L"%s\n",CkJsonObjectW_lastErrorText(jsonToken));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(jsonToken);
return;
}
// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
CkHttpW_putAuthToken(http,CkJsonObjectW_stringOf(jsonToken,L"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 = CkJsonObjectW_Create();
i = 0;
CkJsonObjectW_putI(json,i);
CkJsonObjectW_UpdateString(json,L"carbonCopies[i].email",L"support@chilkatsoft.com");
CkJsonObjectW_UpdateString(json,L"carbonCopies[i].name",L"Chilkat Support");
CkJsonObjectW_UpdateString(json,L"carbonCopies[i].recipientId",L"101");
CkJsonObjectW_UpdateNewObject(json,L"carbonCopies[i].tabs");
i = 0;
CkJsonObjectW_putI(json,i);
CkJsonObjectW_UpdateString(json,L"signers[i].email",L"admin@chilkatsoft.com");
CkJsonObjectW_UpdateString(json,L"signers[i].name",L"Chilkat Admin");
CkJsonObjectW_UpdateString(json,L"signers[i].recipientId",L"1");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorString",L"Please Sign Here");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorXOffset",L"1");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorYOffset",L"0");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent",L"false");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorUnits",L"inches");
i = i + 1;
CkJsonObjectW_putI(json,i);
CkJsonObjectW_UpdateString(json,L"signers[i].email",L"matt@chilkat.io");
CkJsonObjectW_UpdateString(json,L"signers[i].name",L"Matt");
CkJsonObjectW_UpdateString(json,L"signers[i].recipientId",L"2");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorString",L"Please Also Sign Here");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorXOffset",L"1");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorYOffset",L"0");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent",L"false");
CkJsonObjectW_UpdateString(json,L"signers[i].tabs.signHereTabs[0].anchorUnits",L"inches");
sbJson = CkStringBuilderW_Create();
CkJsonObjectW_putEmitCompact(json,FALSE);
CkJsonObjectW_EmitSb(json,sbJson);
CkHttpW_SetRequestHeader(http,L"Cache-Control",L"no-cache");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
// Use your own account ID here.
CkHttpW_SetUrlVar(http,L"accountId",L"7f3f65ed-5e87-418d-94c1-92499ddc8252");
// Use the envelope ID returned by DocuSign when creating the draft envelope).
CkHttpW_SetUrlVar(http,L"envelopeId",L"cee4191c-f94e-4089-9d7c-8033685cbc1a");
url = L"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients";
resp = CkHttpResponseW_Create();
success = CkHttpW_HttpSb(http,L"POST",url,sbJson,L"utf-8",L"application/json",resp);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(jsonToken);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbJson);
CkHttpResponseW_Dispose(resp);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_Load(jResp,CkHttpResponseW_bodyStr(resp));
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(jsonToken);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbJson);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(jResp);
return;
}
// 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 = CkJsonObjectW_stringOf(json,L"recipientCount");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"signers");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
creationReason = CkJsonObjectW_stringOf(json,L"signers[i].creationReason");
requireUploadSignature = CkJsonObjectW_stringOf(json,L"signers[i].requireUploadSignature");
email = CkJsonObjectW_stringOf(json,L"signers[i].email");
recipientId = CkJsonObjectW_stringOf(json,L"signers[i].recipientId");
requireIdLookup = CkJsonObjectW_stringOf(json,L"signers[i].requireIdLookup");
routingOrder = CkJsonObjectW_stringOf(json,L"signers[i].routingOrder");
status = CkJsonObjectW_stringOf(json,L"signers[i].status");
completedCount = CkJsonObjectW_stringOf(json,L"signers[i].completedCount");
deliveryMethod = CkJsonObjectW_stringOf(json,L"signers[i].deliveryMethod");
recipientType = CkJsonObjectW_stringOf(json,L"signers[i].recipientType");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"agents");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"editors");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"intermediaries");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"carbonCopies");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
email = CkJsonObjectW_stringOf(json,L"carbonCopies[i].email");
recipientId = CkJsonObjectW_stringOf(json,L"carbonCopies[i].recipientId");
requireIdLookup = CkJsonObjectW_stringOf(json,L"carbonCopies[i].requireIdLookup");
routingOrder = CkJsonObjectW_stringOf(json,L"carbonCopies[i].routingOrder");
status = CkJsonObjectW_stringOf(json,L"carbonCopies[i].status");
completedCount = CkJsonObjectW_stringOf(json,L"carbonCopies[i].completedCount");
deliveryMethod = CkJsonObjectW_stringOf(json,L"carbonCopies[i].deliveryMethod");
recipientType = CkJsonObjectW_stringOf(json,L"carbonCopies[i].recipientType");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"certifiedDeliveries");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"inPersonSigners");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"seals");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(json,L"witnesses");
while (i < count_i) {
CkJsonObjectW_putI(json,i);
// ...
i = i + 1;
}
// 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"
// }
//
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(jsonToken);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbJson);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(jResp);
}