Chilkat Tools

delphiAx / Support API / Show a Brand

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
content_type: WideString;
content_url: WideString;
deleted: WideString;
file_name: WideString;
height: WideString;
id: WideString;
inline: WideString;
malware_access_override: WideString;
malware_scan_result: WideString;
mapped_content_url: WideString;
size: WideString;
url: WideString;
width: WideString;
Name: WideString;
Subdomain: WideString;
Active: WideString;
Brand_url: WideString;
Created_at: WideString;
Default: WideString;
Has_help_center: WideString;
Help_center_state: WideString;
Host_mapping: WideString;
Id: WideString;
Is_deleted: WideString;
Content_type: WideString;
Content_url: WideString;
Deleted: WideString;
File_name: WideString;
Height: WideString;
LogoId: WideString;
Inline: WideString;
Malware_access_override: WideString;
Malware_scan_result: WideString;
Mapped_content_url: WideString;
Size: WideString;
v_Url: WideString;
Width: WideString;
Signature_template: WideString;
Ticket_form_ids: WideString;
Updated_at: WideString;
brandUrl: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

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

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://example.zendesk.com/api/v2/brands/:brand_id',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

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

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

Chilkat Online Tools

delphiAx / Support API / Show a Brand

Curl Command

Postman Collection Item JSON