Delphi DLL
Delphi DLL
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 Delphi DLL Downloads
uses
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, HttpResponse, JsonObject;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
jsonToken: HCkJsonObject;
json: HCkJsonObject;
i: Integer;
sbJson: HCkStringBuilder;
url: PWideChar;
resp: HCkHttpResponse;
jResp: HCkJsonObject;
respStatusCode: Integer;
creationReason: PWideChar;
requireUploadSignature: PWideChar;
email: PWideChar;
recipientId: PWideChar;
requireIdLookup: PWideChar;
routingOrder: PWideChar;
status: PWideChar;
completedCount: PWideChar;
deliveryMethod: PWideChar;
recipientType: PWideChar;
recipientCount: PWideChar;
count_i: Integer;
begin
success := False;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Load a previously obtained OAuth2 access token.
jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/docusign.json');
if (success = False) then
begin
Memo1.Lines.Add(CkJsonObject__lastErrorText(jsonToken));
Exit;
end;
// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
CkHttp_putAuthToken(http,CkJsonObject__stringOf(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 := CkJsonObject_Create();
i := 0;
CkJsonObject_putI(json,i);
CkJsonObject_UpdateString(json,'carbonCopies[i].email','support@chilkatsoft.com');
CkJsonObject_UpdateString(json,'carbonCopies[i].name','Chilkat Support');
CkJsonObject_UpdateString(json,'carbonCopies[i].recipientId','101');
CkJsonObject_UpdateNewObject(json,'carbonCopies[i].tabs');
i := 0;
CkJsonObject_putI(json,i);
CkJsonObject_UpdateString(json,'signers[i].email','admin@chilkatsoft.com');
CkJsonObject_UpdateString(json,'signers[i].name','Chilkat Admin');
CkJsonObject_UpdateString(json,'signers[i].recipientId','1');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorString','Please Sign Here');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorXOffset','1');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorYOffset','0');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent','false');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorUnits','inches');
i := i + 1;
CkJsonObject_putI(json,i);
CkJsonObject_UpdateString(json,'signers[i].email','matt@chilkat.io');
CkJsonObject_UpdateString(json,'signers[i].name','Matt');
CkJsonObject_UpdateString(json,'signers[i].recipientId','2');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorString','Please Also Sign Here');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorXOffset','1');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorYOffset','0');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorIgnoreIfNotPresent','false');
CkJsonObject_UpdateString(json,'signers[i].tabs.signHereTabs[0].anchorUnits','inches');
sbJson := CkStringBuilder_Create();
CkJsonObject_putEmitCompact(json,False);
CkJsonObject_EmitSb(json,sbJson);
CkHttp_SetRequestHeader(http,'Cache-Control','no-cache');
CkHttp_SetRequestHeader(http,'Accept','application/json');
// Use your own account ID here.
CkHttp_SetUrlVar(http,'accountId','7f3f65ed-5e87-418d-94c1-92499ddc8252');
// Use the envelope ID returned by DocuSign when creating the draft envelope).
CkHttp_SetUrlVar(http,'envelopeId','cee4191c-f94e-4089-9d7c-8033685cbc1a');
url := 'https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/recipients';
resp := CkHttpResponse_Create();
success := CkHttp_HttpSb(http,'POST',url,sbJson,'utf-8','application/json',resp);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_Load(jResp,CkHttpResponse__bodyStr(resp));
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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 := CkJsonObject__stringOf(json,'recipientCount');
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'signers');
while i < count_i do
begin
CkJsonObject_putI(json,i);
creationReason := CkJsonObject__stringOf(json,'signers[i].creationReason');
requireUploadSignature := CkJsonObject__stringOf(json,'signers[i].requireUploadSignature');
email := CkJsonObject__stringOf(json,'signers[i].email');
recipientId := CkJsonObject__stringOf(json,'signers[i].recipientId');
requireIdLookup := CkJsonObject__stringOf(json,'signers[i].requireIdLookup');
routingOrder := CkJsonObject__stringOf(json,'signers[i].routingOrder');
status := CkJsonObject__stringOf(json,'signers[i].status');
completedCount := CkJsonObject__stringOf(json,'signers[i].completedCount');
deliveryMethod := CkJsonObject__stringOf(json,'signers[i].deliveryMethod');
recipientType := CkJsonObject__stringOf(json,'signers[i].recipientType');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'agents');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'editors');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'intermediaries');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'carbonCopies');
while i < count_i do
begin
CkJsonObject_putI(json,i);
email := CkJsonObject__stringOf(json,'carbonCopies[i].email');
recipientId := CkJsonObject__stringOf(json,'carbonCopies[i].recipientId');
requireIdLookup := CkJsonObject__stringOf(json,'carbonCopies[i].requireIdLookup');
routingOrder := CkJsonObject__stringOf(json,'carbonCopies[i].routingOrder');
status := CkJsonObject__stringOf(json,'carbonCopies[i].status');
completedCount := CkJsonObject__stringOf(json,'carbonCopies[i].completedCount');
deliveryMethod := CkJsonObject__stringOf(json,'carbonCopies[i].deliveryMethod');
recipientType := CkJsonObject__stringOf(json,'carbonCopies[i].recipientType');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'certifiedDeliveries');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'inPersonSigners');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'seals');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(json,'witnesses');
while i < count_i do
begin
CkJsonObject_putI(json,i);
// ...
i := i + 1;
end;
// 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_Dispose(http);
CkJsonObject_Dispose(jsonToken);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbJson);
CkHttpResponse_Dispose(resp);
CkJsonObject_Dispose(jResp);
end;