unicodeCpp / Support API / List Brands
Back to Collection Items
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"password");
http.SetRequestHeader(L"Accept",L"application/json");
CkStringBuilderW sbResponseBody;
success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/brands",sbResponseBody);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = http.get_LastStatus();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",http.lastHeader());
wprintf(L"Failed.\n");
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const wchar_t *name = 0;
const wchar_t *subdomain = 0;
const wchar_t *active = 0;
const wchar_t *brand_url = 0;
const wchar_t *created_at = 0;
const wchar_t *default = 0;
const wchar_t *has_help_center = 0;
const wchar_t *help_center_state = 0;
const wchar_t *host_mapping = 0;
const wchar_t *id = 0;
const wchar_t *is_deleted = 0;
const wchar_t *Content_type = 0;
const wchar_t *Content_url = 0;
const wchar_t *Deleted = 0;
const wchar_t *File_name = 0;
const wchar_t *Height = 0;
const wchar_t *Id = 0;
const wchar_t *Inline = 0;
const wchar_t *Malware_access_override = 0;
const wchar_t *Malware_scan_result = 0;
const wchar_t *Mapped_content_url = 0;
const wchar_t *Size = 0;
const wchar_t *v_Url = 0;
const wchar_t *Width = 0;
const wchar_t *signature_template = 0;
const wchar_t *ticket_form_ids = 0;
const wchar_t *updated_at = 0;
const wchar_t *url = 0;
int j;
int count_j;
const wchar_t *content_type = 0;
const wchar_t *content_url = 0;
const wchar_t *deleted = 0;
const wchar_t *file_name = 0;
const wchar_t *height = 0;
const wchar_t *inline = 0;
const wchar_t *malware_access_override = 0;
const wchar_t *malware_scan_result = 0;
const wchar_t *mapped_content_url = 0;
const wchar_t *size = 0;
const wchar_t *width = 0;
const wchar_t *count = jResp.stringOf(L"count");
const wchar_t *next_page = jResp.stringOf(L"next_page");
const wchar_t *previous_page = jResp.stringOf(L"previous_page");
int i = 0;
int count_i = jResp.SizeOfArray(L"brands");
while (i < count_i) {
jResp.put_I(i);
name = jResp.stringOf(L"brands[i].name");
subdomain = jResp.stringOf(L"brands[i].subdomain");
active = jResp.stringOf(L"brands[i].active");
brand_url = jResp.stringOf(L"brands[i].brand_url");
created_at = jResp.stringOf(L"brands[i].created_at");
default = jResp.stringOf(L"brands[i].default");
has_help_center = jResp.stringOf(L"brands[i].has_help_center");
help_center_state = jResp.stringOf(L"brands[i].help_center_state");
host_mapping = jResp.stringOf(L"brands[i].host_mapping");
id = jResp.stringOf(L"brands[i].id");
is_deleted = jResp.stringOf(L"brands[i].is_deleted");
Content_type = jResp.stringOf(L"brands[i].logo.content_type");
Content_url = jResp.stringOf(L"brands[i].logo.content_url");
Deleted = jResp.stringOf(L"brands[i].logo.deleted");
File_name = jResp.stringOf(L"brands[i].logo.file_name");
Height = jResp.stringOf(L"brands[i].logo.height");
Id = jResp.stringOf(L"brands[i].logo.id");
Inline = jResp.stringOf(L"brands[i].logo.inline");
Malware_access_override = jResp.stringOf(L"brands[i].logo.malware_access_override");
Malware_scan_result = jResp.stringOf(L"brands[i].logo.malware_scan_result");
Mapped_content_url = jResp.stringOf(L"brands[i].logo.mapped_content_url");
Size = jResp.stringOf(L"brands[i].logo.size");
v_Url = jResp.stringOf(L"brands[i].logo.url");
Width = jResp.stringOf(L"brands[i].logo.width");
signature_template = jResp.stringOf(L"brands[i].signature_template");
ticket_form_ids = jResp.stringOf(L"brands[i].ticket_form_ids");
updated_at = jResp.stringOf(L"brands[i].updated_at");
url = jResp.stringOf(L"brands[i].url");
j = 0;
count_j = jResp.SizeOfArray(L"brands[i].logo.thumbnails");
while (j < count_j) {
jResp.put_J(j);
content_type = jResp.stringOf(L"brands[i].logo.thumbnails[j].content_type");
content_url = jResp.stringOf(L"brands[i].logo.thumbnails[j].content_url");
deleted = jResp.stringOf(L"brands[i].logo.thumbnails[j].deleted");
file_name = jResp.stringOf(L"brands[i].logo.thumbnails[j].file_name");
height = jResp.stringOf(L"brands[i].logo.thumbnails[j].height");
id = jResp.stringOf(L"brands[i].logo.thumbnails[j].id");
inline = jResp.stringOf(L"brands[i].logo.thumbnails[j].inline");
malware_access_override = jResp.stringOf(L"brands[i].logo.thumbnails[j].malware_access_override");
malware_scan_result = jResp.stringOf(L"brands[i].logo.thumbnails[j].malware_scan_result");
mapped_content_url = jResp.stringOf(L"brands[i].logo.thumbnails[j].mapped_content_url");
size = jResp.stringOf(L"brands[i].logo.thumbnails[j].size");
url = jResp.stringOf(L"brands[i].logo.thumbnails[j].url");
width = jResp.stringOf(L"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}"
}
]
}
