Chilkat Online Tools

Node.js / Support API / Show a Brand

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    http.SetRequestHeader("Accept","application/json");

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/brands/:brand_id",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.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)

    // {
    //   "brand": {
    //     "name": "<string>",
    //     "subdomain": "<string>",
    //     "active": "<boolean>",
    //     "brand_url": "<string>",
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "has_help_center": "<boolean>",
    //     "help_center_state": "enabled",
    //     "host_mapping": "<string>",
    //     "id": "<integer>",
    //     "is_deleted": "<boolean>",
    //     "logo": {
    //       "content_type": "<string>",
    //       "content_url": "<string>",
    //       "deleted": "<boolean>",
    //       "file_name": "<string>",
    //       "height": "<string>",
    //       "id": "<integer>",
    //       "inline": "<boolean>",
    //       "malware_access_override": "<boolean>",
    //       "malware_scan_result": "<string>",
    //       "mapped_content_url": "<string>",
    //       "size": "<integer>",
    //       "url": "<string>",
    //       "width": "<string>",
    //       "thumbnails": [
    //         {
    //           "content_type": "<string>",
    //           "content_url": "<string>",
    //           "deleted": "<boolean>",
    //           "file_name": "<string>",
    //           "height": "<string>",
    //           "id": "<integer>",
    //           "inline": "<boolean>",
    //           "malware_access_override": "<boolean>",
    //           "malware_scan_result": "<string>",
    //           "mapped_content_url": "<string>",
    //           "size": "<integer>",
    //           "url": "<string>",
    //           "width": "<string>"
    //         },
    //         {
    //           "content_type": "<string>",
    //           "content_url": "<string>",
    //           "deleted": "<boolean>",
    //           "file_name": "<string>",
    //           "height": "<string>",
    //           "id": "<integer>",
    //           "inline": "<boolean>",
    //           "malware_access_override": "<boolean>",
    //           "malware_scan_result": "<string>",
    //           "mapped_content_url": "<string>",
    //           "size": "<integer>",
    //           "url": "<string>",
    //           "width": "<string>"
    //         }
    //       ]
    //     },
    //     "signature_template": "<string>",
    //     "ticket_form_ids": "<array>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>"
    //   }
    // }

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

    var content_type;
    var content_url;
    var deleted;
    var file_name;
    var height;
    var id;
    var inline;
    var malware_access_override;
    var malware_scan_result;
    var mapped_content_url;
    var size;
    var url;
    var width;

    var Name = jResp.StringOf("brand.name");
    var Subdomain = jResp.StringOf("brand.subdomain");
    var Active = jResp.StringOf("brand.active");
    var Brand_url = jResp.StringOf("brand.brand_url");
    var Created_at = jResp.StringOf("brand.created_at");
    var Default = jResp.StringOf("brand.default");
    var Has_help_center = jResp.StringOf("brand.has_help_center");
    var Help_center_state = jResp.StringOf("brand.help_center_state");
    var Host_mapping = jResp.StringOf("brand.host_mapping");
    var Id = jResp.StringOf("brand.id");
    var Is_deleted = jResp.StringOf("brand.is_deleted");
    var Content_type = jResp.StringOf("brand.logo.content_type");
    var Content_url = jResp.StringOf("brand.logo.content_url");
    var Deleted = jResp.StringOf("brand.logo.deleted");
    var File_name = jResp.StringOf("brand.logo.file_name");
    var Height = jResp.StringOf("brand.logo.height");
    var LogoId = jResp.StringOf("brand.logo.id");
    var Inline = jResp.StringOf("brand.logo.inline");
    var Malware_access_override = jResp.StringOf("brand.logo.malware_access_override");
    var Malware_scan_result = jResp.StringOf("brand.logo.malware_scan_result");
    var Mapped_content_url = jResp.StringOf("brand.logo.mapped_content_url");
    var Size = jResp.StringOf("brand.logo.size");
    var v_Url = jResp.StringOf("brand.logo.url");
    var Width = jResp.StringOf("brand.logo.width");
    var Signature_template = jResp.StringOf("brand.signature_template");
    var Ticket_form_ids = jResp.StringOf("brand.ticket_form_ids");
    var Updated_at = jResp.StringOf("brand.updated_at");
    var brandUrl = jResp.StringOf("brand.url");
    var i = 0;
    var count_i = jResp.SizeOfArray("brand.logo.thumbnails");
    while (i < count_i) {
        jResp.I = i;
        content_type = jResp.StringOf("brand.logo.thumbnails[i].content_type");
        content_url = jResp.StringOf("brand.logo.thumbnails[i].content_url");
        deleted = jResp.StringOf("brand.logo.thumbnails[i].deleted");
        file_name = jResp.StringOf("brand.logo.thumbnails[i].file_name");
        height = jResp.StringOf("brand.logo.thumbnails[i].height");
        id = jResp.StringOf("brand.logo.thumbnails[i].id");
        inline = jResp.StringOf("brand.logo.thumbnails[i].inline");
        malware_access_override = jResp.StringOf("brand.logo.thumbnails[i].malware_access_override");
        malware_scan_result = jResp.StringOf("brand.logo.thumbnails[i].malware_scan_result");
        mapped_content_url = jResp.StringOf("brand.logo.thumbnails[i].mapped_content_url");
        size = jResp.StringOf("brand.logo.thumbnails[i].size");
        url = jResp.StringOf("brand.logo.thumbnails[i].url");
        width = jResp.StringOf("brand.logo.thumbnails[i].width");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/brands/:brand_id

Postman Collection Item JSON

{
  "name": "Show a Brand",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/brands/:brand_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "brands",
        ":brand_id"
      ],
      "variable": [
        {
          "key": "brand_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns a brand for your account.\n\n#### Allowed for\n\n* Admins, Agents"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/brands/:brand_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "brands",
            ":brand_id"
          ],
          "variable": [
            {
              "key": "brand_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}