Chilkat Tools

.NET Core C# / Support API / List Brands

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/brands",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

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

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "count": "<integer>",
//   "next_page": "<string>",
//   "previous_page": "<string>",
//   "brands": [
//     {
//       "name": "<string>",
//       "subdomain": "<string>",
//       "active": "<boolean>",
//       "brand_url": "<string>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "has_help_center": "<boolean>",
//       "help_center_state": "restricted",
//       "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>"
//     },
//     {
//       "name": "<string>",
//       "subdomain": "<string>",
//       "active": "<boolean>",
//       "brand_url": "<string>",
//       "created_at": "<dateTime>",
//       "default": "<boolean>",
//       "has_help_center": "<boolean>",
//       "help_center_state": "restricted",
//       "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

string name;
string subdomain;
string active;
string brand_url;
string created_at;
string default;
string has_help_center;
string help_center_state;
string host_mapping;
string id;
string is_deleted;
string Content_type;
string Content_url;
string Deleted;
string File_name;
string Height;
string Id;
string Inline;
string Malware_access_override;
string Malware_scan_result;
string Mapped_content_url;
string Size;
string v_Url;
string Width;
string signature_template;
string ticket_form_ids;
string updated_at;
string url;
int j;
int count_j;
string content_type;
string content_url;
string deleted;
string file_name;
string height;
string inline;
string malware_access_override;
string malware_scan_result;
string mapped_content_url;
string size;
string width;

string count = jResp.StringOf("count");
string next_page = jResp.StringOf("next_page");
string previous_page = jResp.StringOf("previous_page");
int i = 0;
int count_i = jResp.SizeOfArray("brands");
while (i < count_i) {
    jResp.I = i;
    name = jResp.StringOf("brands[i].name");
    subdomain = jResp.StringOf("brands[i].subdomain");
    active = jResp.StringOf("brands[i].active");
    brand_url = jResp.StringOf("brands[i].brand_url");
    created_at = jResp.StringOf("brands[i].created_at");
    default = jResp.StringOf("brands[i].default");
    has_help_center = jResp.StringOf("brands[i].has_help_center");
    help_center_state = jResp.StringOf("brands[i].help_center_state");
    host_mapping = jResp.StringOf("brands[i].host_mapping");
    id = jResp.StringOf("brands[i].id");
    is_deleted = jResp.StringOf("brands[i].is_deleted");
    Content_type = jResp.StringOf("brands[i].logo.content_type");
    Content_url = jResp.StringOf("brands[i].logo.content_url");
    Deleted = jResp.StringOf("brands[i].logo.deleted");
    File_name = jResp.StringOf("brands[i].logo.file_name");
    Height = jResp.StringOf("brands[i].logo.height");
    Id = jResp.StringOf("brands[i].logo.id");
    Inline = jResp.StringOf("brands[i].logo.inline");
    Malware_access_override = jResp.StringOf("brands[i].logo.malware_access_override");
    Malware_scan_result = jResp.StringOf("brands[i].logo.malware_scan_result");
    Mapped_content_url = jResp.StringOf("brands[i].logo.mapped_content_url");
    Size = jResp.StringOf("brands[i].logo.size");
    v_Url = jResp.StringOf("brands[i].logo.url");
    Width = jResp.StringOf("brands[i].logo.width");
    signature_template = jResp.StringOf("brands[i].signature_template");
    ticket_form_ids = jResp.StringOf("brands[i].ticket_form_ids");
    updated_at = jResp.StringOf("brands[i].updated_at");
    url = jResp.StringOf("brands[i].url");
    j = 0;
    count_j = jResp.SizeOfArray("brands[i].logo.thumbnails");
    while (j < count_j) {
        jResp.J = j;
        content_type = jResp.StringOf("brands[i].logo.thumbnails[j].content_type");
        content_url = jResp.StringOf("brands[i].logo.thumbnails[j].content_url");
        deleted = jResp.StringOf("brands[i].logo.thumbnails[j].deleted");
        file_name = jResp.StringOf("brands[i].logo.thumbnails[j].file_name");
        height = jResp.StringOf("brands[i].logo.thumbnails[j].height");
        id = jResp.StringOf("brands[i].logo.thumbnails[j].id");
        inline = jResp.StringOf("brands[i].logo.thumbnails[j].inline");
        malware_access_override = jResp.StringOf("brands[i].logo.thumbnails[j].malware_access_override");
        malware_scan_result = jResp.StringOf("brands[i].logo.thumbnails[j].malware_scan_result");
        mapped_content_url = jResp.StringOf("brands[i].logo.thumbnails[j].mapped_content_url");
        size = jResp.StringOf("brands[i].logo.thumbnails[j].size");
        url = jResp.StringOf("brands[i].logo.thumbnails[j].url");
        width = jResp.StringOf("brands[i].logo.thumbnails[j].width");
        j = j + 1;
    }

    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Brands",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/brands",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "brands"
      ]
    },
    "description": "Returns a list of all brands for your account sorted by name.\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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "brands"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\",\n  \"brands\": [\n    {\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\": \"restricted\",\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    {\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\": \"restricted\",\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  ]\n}"
    }
  ]
}

Chilkat Online Tools

.NET Core C# / Support API / List Brands

Curl Command

Postman Collection Item JSON