Objective-C

DocuSign List Folder Items

See more DocuSign Examples

Retrieves a list of the envelopes in the specified folder. Objective-C

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <NSString.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];

// Implements the following HTTP request:
// GET /restapi/v2.1/accounts/{accountId}/folders/{folderId}

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

http.AuthToken = [jsonToken StringOf: @"access_token"];

// Use your account ID and a valid folderId here:
[http SetUrlVar: @"accountId" value: @"7f3f65ed-5e87-418d-94c1-92499ddc8252"];
[http SetUrlVar: @"folderId" value: @"94644782-31b7-4f82-a2c1-26d8a9306f8c"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders/{$folderId}" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

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

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastResponseHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

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

// {
//   "resultSetSize": "sample string 1",
//   "startPosition": "sample string 2",
//   "endPosition": "sample string 3",
//   "totalSetSize": "sample string 4",
//   "previousUri": "sample string 5",
//   "nextUri": "sample string 6",
//   "folderItems": [
//     {
//       "ownerName": "sample string 1",
//       "envelopeId": "sample string 2",
//       "envelopeUri": "sample string 3",
//       "status": "sample string 4",
//       "senderName": "sample string 5",
//       "senderEmail": "sample string 6",
//       "createdDateTime": "sample string 7",
//       "sentDateTime": "sample string 8",
//       "completedDateTime": "sample string 9",
//       "subject": "sample string 10",
//       "templateId": "sample string 11",
//       "name": "sample string 12",
//       "shared": "sample string 13",
//       "password": "sample string 14",
//       "description": "sample string 15",
//       "lastModified": "sample string 16",
//       "pageCount": 17,
//       "uri": "sample string 18",
//       "is21CFRPart11": "sample string 19",
//       "isSignatureProviderEnvelope": "sample string 20",
//       "customFields": [
//         {
//           "fieldId": "sample string 1",
//           "name": "sample string 2",
//           "show": "sample string 3",
//           "required": "sample string 4",
//           "value": "sample string 5",
//           "configurationType": "sample string 6",
//           "errorDetails": {
//             "errorCode": "sample string 1",
//             "message": "sample string 2"
//           }
//         }
//       ]
//     }
//   ]
// }

// 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 *ownerName = 0;
NSString *envelopeId = 0;
NSString *envelopeUri = 0;
NSString *status = 0;
NSString *senderName = 0;
NSString *senderEmail = 0;
NSString *createdDateTime = 0;
NSString *sentDateTime = 0;
NSString *completedDateTime = 0;
NSString *subject = 0;
NSString *templateId = 0;
NSString *name = 0;
NSString *shared = 0;
NSString *password = 0;
NSString *description = 0;
NSString *lastModified = 0;
int pageCount;
NSString *uri = 0;
NSString *is21CFRPart11 = 0;
NSString *isSignatureProviderEnvelope = 0;
int j;
int count_j;
NSString *fieldId = 0;
NSString *show = 0;
NSString *required = 0;
NSString *value = 0;
NSString *configurationType = 0;
NSString *errorDetailsErrorCode = 0;
NSString *errorDetailsMessage = 0;

NSString *resultSetSize = [jResp StringOf: @"resultSetSize"];
NSString *startPosition = [jResp StringOf: @"startPosition"];
NSString *endPosition = [jResp StringOf: @"endPosition"];
NSString *totalSetSize = [jResp StringOf: @"totalSetSize"];
NSString *previousUri = [jResp StringOf: @"previousUri"];
NSString *nextUri = [jResp StringOf: @"nextUri"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"folderItems"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    ownerName = [jResp StringOf: @"folderItems[i].ownerName"];
    envelopeId = [jResp StringOf: @"folderItems[i].envelopeId"];
    envelopeUri = [jResp StringOf: @"folderItems[i].envelopeUri"];
    status = [jResp StringOf: @"folderItems[i].status"];
    senderName = [jResp StringOf: @"folderItems[i].senderName"];
    senderEmail = [jResp StringOf: @"folderItems[i].senderEmail"];
    createdDateTime = [jResp StringOf: @"folderItems[i].createdDateTime"];
    sentDateTime = [jResp StringOf: @"folderItems[i].sentDateTime"];
    completedDateTime = [jResp StringOf: @"folderItems[i].completedDateTime"];
    subject = [jResp StringOf: @"folderItems[i].subject"];
    templateId = [jResp StringOf: @"folderItems[i].templateId"];
    name = [jResp StringOf: @"folderItems[i].name"];
    shared = [jResp StringOf: @"folderItems[i].shared"];
    password = [jResp StringOf: @"folderItems[i].password"];
    description = [jResp StringOf: @"folderItems[i].description"];
    lastModified = [jResp StringOf: @"folderItems[i].lastModified"];
    pageCount = [[jResp IntOf: @"folderItems[i].pageCount"] intValue];
    uri = [jResp StringOf: @"folderItems[i].uri"];
    is21CFRPart11 = [jResp StringOf: @"folderItems[i].is21CFRPart11"];
    isSignatureProviderEnvelope = [jResp StringOf: @"folderItems[i].isSignatureProviderEnvelope"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"folderItems[i].customFields"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        fieldId = [jResp StringOf: @"folderItems[i].customFields[j].fieldId"];
        name = [jResp StringOf: @"folderItems[i].customFields[j].name"];
        show = [jResp StringOf: @"folderItems[i].customFields[j].show"];
        required = [jResp StringOf: @"folderItems[i].customFields[j].required"];
        value = [jResp StringOf: @"folderItems[i].customFields[j].value"];
        configurationType = [jResp StringOf: @"folderItems[i].customFields[j].configurationType"];
        errorDetailsErrorCode = [jResp StringOf: @"folderItems[i].customFields[j].errorDetails.errorCode"];
        errorDetailsMessage = [jResp StringOf: @"folderItems[i].customFields[j].errorDetails.message"];
        j = j + 1;
    }

    i = i + 1;
}