Chilkat Online Tools

C / Support API / Show a Brand

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *content_type;
    const char *content_url;
    const char *deleted;
    const char *file_name;
    const char *height;
    const char *id;
    const char *inline;
    const char *malware_access_override;
    const char *malware_scan_result;
    const char *mapped_content_url;
    const char *size;
    const char *url;
    const char *width;
    const char *Name;
    const char *Subdomain;
    const char *Active;
    const char *Brand_url;
    const char *Created_at;
    const char *Default;
    const char *Has_help_center;
    const char *Help_center_state;
    const char *Host_mapping;
    const char *Id;
    const char *Is_deleted;
    const char *Content_type;
    const char *Content_url;
    const char *Deleted;
    const char *File_name;
    const char *Height;
    const char *LogoId;
    const char *Inline;
    const char *Malware_access_override;
    const char *Malware_scan_result;
    const char *Mapped_content_url;
    const char *Size;
    const char *v_Url;
    const char *Width;
    const char *Signature_template;
    const char *Ticket_form_ids;
    const char *Updated_at;
    const char *brandUrl;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    CkHttp_putBasicAuth(http,TRUE);
    CkHttp_putLogin(http,"login");
    CkHttp_putPassword(http,"password");

    CkHttp_SetRequestHeader(http,"Accept","application/json");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/brands/:brand_id",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

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



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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