Objective-C

DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope. Objective-C

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoBinData.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoHttpResponse.h>

BOOL success = NO;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];

// Load a previously obtained OAuth2 access token.
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
success = [jsonToken LoadFile: @"qa_data/tokens/docusign.json"];
if (success == NO) {
    NSLog(@"%@",jsonToken.LastErrorText);
    return;
}

// 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)

// PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID>/documents HTTP/1.1
// Expect: 100-continue
// Accept: application/json
// Cache-Control: no-cache
// Authorization: Bearer eyJ0eX...
// Content-Length: ...
// Content-Type: application/json
// 
// {
// 	"documents": [
// 		{
// 		"documentId": "1",
// 		"name": "project_xyz.pdf",
// 		"pages": "1",
// 		"documentBase64": "<insert base64 content here>"
// 		}
// 	]
// }

CkoBinData *bd1 = [[CkoBinData alloc] init];
success = [bd1 LoadFile: @"qa_data/pdf/project_xyz.pdf"];

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"documents[0].documentId" value: @"1"];
[json UpdateString: @"documents[0].name" value: @"project_xyz.pdf"];
[json UpdateString: @"documents[0].pages" value: @"1"];
[json UpdateString: @"documents[0].documentBase64" value: [bd1 GetEncoded: @"base64"]];

CkoStringBuilder *sbJson = [[CkoStringBuilder alloc] init];
json.EmitCompact = NO;
[json EmitSb: sbJson];

[http SetRequestHeader: @"Expect" value: @"100-continue"];
[http SetRequestHeader: @"Cache-Control" value: @"no-cache"];
[http SetRequestHeader: @"Accept" value: @"application/json"];

// Use your own account ID here.
[http SetUrlVar: @"accountId" value: @"7f3f65ed-5e87-418d-94c1-92499ddc8252"];
// Use the envelope ID returned by DocuSign when creating the draft envelope).
[http SetUrlVar: @"envelopeId" value: @"cee4191c-f94e-4089-9d7c-8033685cbc1a"];

NSString *url = @"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents";
CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpSb: @"PUT" url: url sb: sbJson charset: @"utf-8" contentType: @"application/json" response: resp];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp Load: resp.BodyStr];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

// If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
//   "envelopeDocuments": [
//     {
//       "documentId": "1",
//       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
//       "name": "project_xyz.pdf",
//       "type": "content",
//       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
//       "order": "3",
//       "containsPdfFormFields": "false",
//       "templateRequired": "false",
//       "authoritativeCopy": "false"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

NSString *documentId = 0;
NSString *documentIdGuid = 0;
NSString *name = 0;
NSString *v_type = 0;
NSString *uri = 0;
NSString *order = 0;
NSString *containsPdfFormFields = 0;
NSString *templateRequired = 0;
NSString *authoritativeCopy = 0;

NSString *envelopeId = [jResp StringOf: @"envelopeId"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"envelopeDocuments"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    documentId = [jResp StringOf: @"envelopeDocuments[i].documentId"];
    documentIdGuid = [jResp StringOf: @"envelopeDocuments[i].documentIdGuid"];
    name = [jResp StringOf: @"envelopeDocuments[i].name"];
    v_type = [jResp StringOf: @"envelopeDocuments[i].type"];
    uri = [jResp StringOf: @"envelopeDocuments[i].uri"];
    order = [jResp StringOf: @"envelopeDocuments[i].order"];
    containsPdfFormFields = [jResp StringOf: @"envelopeDocuments[i].containsPdfFormFields"];
    templateRequired = [jResp StringOf: @"envelopeDocuments[i].templateRequired"];
    authoritativeCopy = [jResp StringOf: @"envelopeDocuments[i].authoritativeCopy"];
    i = i + 1;
}