JavaScript

Docusign: Return Brand Data Associated with a User

See more DocuSign Examples

Demonstrates a call using an OAuth2 access token in combination with the account ID for which we have authorization. JavaScript

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl --request GET https://account-d.docusign.com/restapi/v2/accounts/18b4799a-xxxx-xxxx-xxxx-b5b4b8a97604/brands --header "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ"

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
var jsonToken = new CkJsonObject();
// Load a previously obtained OAuth2 access token.
success = jsonToken.LoadFile("qa_data/tokens/docusign.json");
if (success == false) {
    console.log(jsonToken.LastErrorText);
    return;
}

http.AuthToken = jsonToken.StringOf("access_token");

// Use an account ID obtained from DocuSign Get User Account Data
var sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://account-d.docusign.com/restapi/v2/accounts/18b4799a-xxxx-xxxx-xxxx-b5b4b8a97604/brands",sbResponseBody);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var json = new CkJsonObject();
json.LoadSb(sbResponseBody);
json.EmitCompact = false;

console.log("Response Body:");
console.log(json.Emit());

var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(http.LastHeader);
    console.log("Failed.");
    return;
}

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

// {
//   "recipientBrandIdDefault": "sample string 1",
//   "senderBrandIdDefault": "sample string 2",
//   "brands": [
//     {
//       "brandCompany": "sample string 1",
//       "brandId": "sample string 2",
//       "brandName": "sample string 3",
//       "colors": [
//         {}
//       ],
//       "errorDetails": {
//         "errorCode": "sample string 1",
//         "message": "sample string 2"
//       },
//       "isOverridingCompanyName": "sample string 4",
//       "isSendingDefault": "sample string 5",
//       "isSigningDefault": "sample string 6",
//       "landingPages": [
//         {}
//       ],
//       "links": [
//         {
//           "linkType": "sample string 1",
//           "urlOrMailTo": "sample string 2",
//           "linkText": "sample string 3",
//           "showLink": "sample string 4"
//         }
//       ],
//       "emailContent": [
//         {
//           "emailContentType": "sample string 1",
//           "content": "sample string 2",
//           "emailToLink": "sample string 3",
//           "linkText": "sample string 4"
//         }
//       ],
//       "logos": {
//         "primary": "sample string 1",
//         "secondary": "sample string 2",
//         "email": "sample string 3"
//       },
//       "resources": {
//         "email": "sample string 1",
//         "sending": "sample string 2",
//         "signing": "sample string 3",
//         "signingCaptive": "sample string 4"
//       }
//     }
//   ]
// }

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

var brandCompany;
var brandId;
var brandName;
var errorDetailsErrorCode;
var errorDetailsMessage;
var isOverridingCompanyName;
var isSendingDefault;
var isSigningDefault;
var logosPrimary;
var logosSecondary;
var logosEmail;
var resourcesEmail;
var resourcesSending;
var resourcesSigning;
var resourcesSigningCaptive;
var j;
var count_j;
var linkType;
var urlOrMailTo;
var linkText;
var showLink;
var emailContentType;
var content;
var emailToLink;

var recipientBrandIdDefault = json.StringOf("recipientBrandIdDefault");
var senderBrandIdDefault = json.StringOf("senderBrandIdDefault");
var i = 0;
var count_i = json.SizeOfArray("brands");
while (i < count_i) {
    json.I = i;
    brandCompany = json.StringOf("brands[i].brandCompany");
    brandId = json.StringOf("brands[i].brandId");
    brandName = json.StringOf("brands[i].brandName");
    errorDetailsErrorCode = json.StringOf("brands[i].errorDetails.errorCode");
    errorDetailsMessage = json.StringOf("brands[i].errorDetails.message");
    isOverridingCompanyName = json.StringOf("brands[i].isOverridingCompanyName");
    isSendingDefault = json.StringOf("brands[i].isSendingDefault");
    isSigningDefault = json.StringOf("brands[i].isSigningDefault");
    logosPrimary = json.StringOf("brands[i].logos.primary");
    logosSecondary = json.StringOf("brands[i].logos.secondary");
    logosEmail = json.StringOf("brands[i].logos.email");
    resourcesEmail = json.StringOf("brands[i].resources.email");
    resourcesSending = json.StringOf("brands[i].resources.sending");
    resourcesSigning = json.StringOf("brands[i].resources.signing");
    resourcesSigningCaptive = json.StringOf("brands[i].resources.signingCaptive");
    j = 0;
    count_j = json.SizeOfArray("brands[i].colors");
    while (j < count_j) {
        json.J = j;
        j = j+1;
    }

    j = 0;
    count_j = json.SizeOfArray("brands[i].landingPages");
    while (j < count_j) {
        json.J = j;
        j = j+1;
    }

    j = 0;
    count_j = json.SizeOfArray("brands[i].links");
    while (j < count_j) {
        json.J = j;
        linkType = json.StringOf("brands[i].links[j].linkType");
        urlOrMailTo = json.StringOf("brands[i].links[j].urlOrMailTo");
        linkText = json.StringOf("brands[i].links[j].linkText");
        showLink = json.StringOf("brands[i].links[j].showLink");
        j = j+1;
    }

    j = 0;
    count_j = json.SizeOfArray("brands[i].emailContent");
    while (j < count_j) {
        json.J = j;
        emailContentType = json.StringOf("brands[i].emailContent[j].emailContentType");
        content = json.StringOf("brands[i].emailContent[j].content");
        emailToLink = json.StringOf("brands[i].emailContent[j].emailToLink");
        linkText = json.StringOf("brands[i].emailContent[j].linkText");
        j = j+1;
    }

    i = i+1;
}