Chilkat Online Tools

.NET Core C# / Support API / Show a Brand

Back to Collection Items

// 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/:brand_id",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)

// {
//   "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

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 url;
string width;

string Name = jResp.StringOf("brand.name");
string Subdomain = jResp.StringOf("brand.subdomain");
string Active = jResp.StringOf("brand.active");
string Brand_url = jResp.StringOf("brand.brand_url");
string Created_at = jResp.StringOf("brand.created_at");
string Default = jResp.StringOf("brand.default");
string Has_help_center = jResp.StringOf("brand.has_help_center");
string Help_center_state = jResp.StringOf("brand.help_center_state");
string Host_mapping = jResp.StringOf("brand.host_mapping");
string Id = jResp.StringOf("brand.id");
string Is_deleted = jResp.StringOf("brand.is_deleted");
string Content_type = jResp.StringOf("brand.logo.content_type");
string Content_url = jResp.StringOf("brand.logo.content_url");
string Deleted = jResp.StringOf("brand.logo.deleted");
string File_name = jResp.StringOf("brand.logo.file_name");
string Height = jResp.StringOf("brand.logo.height");
string LogoId = jResp.StringOf("brand.logo.id");
string Inline = jResp.StringOf("brand.logo.inline");
string Malware_access_override = jResp.StringOf("brand.logo.malware_access_override");
string Malware_scan_result = jResp.StringOf("brand.logo.malware_scan_result");
string Mapped_content_url = jResp.StringOf("brand.logo.mapped_content_url");
string Size = jResp.StringOf("brand.logo.size");
string v_Url = jResp.StringOf("brand.logo.url");
string Width = jResp.StringOf("brand.logo.width");
string Signature_template = jResp.StringOf("brand.signature_template");
string Ticket_form_ids = jResp.StringOf("brand.ticket_form_ids");
string Updated_at = jResp.StringOf("brand.updated_at");
string brandUrl = jResp.StringOf("brand.url");
int i = 0;
int 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;
}

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}"
    }
  ]
}