Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/brands/:brand_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set Name [CkJsonObject_stringOf $jResp "brand.name"]
set Subdomain [CkJsonObject_stringOf $jResp "brand.subdomain"]
set Active [CkJsonObject_stringOf $jResp "brand.active"]
set Brand_url [CkJsonObject_stringOf $jResp "brand.brand_url"]
set Created_at [CkJsonObject_stringOf $jResp "brand.created_at"]
set Default [CkJsonObject_stringOf $jResp "brand.default"]
set Has_help_center [CkJsonObject_stringOf $jResp "brand.has_help_center"]
set Help_center_state [CkJsonObject_stringOf $jResp "brand.help_center_state"]
set Host_mapping [CkJsonObject_stringOf $jResp "brand.host_mapping"]
set Id [CkJsonObject_stringOf $jResp "brand.id"]
set Is_deleted [CkJsonObject_stringOf $jResp "brand.is_deleted"]
set Content_type [CkJsonObject_stringOf $jResp "brand.logo.content_type"]
set Content_url [CkJsonObject_stringOf $jResp "brand.logo.content_url"]
set Deleted [CkJsonObject_stringOf $jResp "brand.logo.deleted"]
set File_name [CkJsonObject_stringOf $jResp "brand.logo.file_name"]
set Height [CkJsonObject_stringOf $jResp "brand.logo.height"]
set LogoId [CkJsonObject_stringOf $jResp "brand.logo.id"]
set Inline [CkJsonObject_stringOf $jResp "brand.logo.inline"]
set Malware_access_override [CkJsonObject_stringOf $jResp "brand.logo.malware_access_override"]
set Malware_scan_result [CkJsonObject_stringOf $jResp "brand.logo.malware_scan_result"]
set Mapped_content_url [CkJsonObject_stringOf $jResp "brand.logo.mapped_content_url"]
set Size [CkJsonObject_stringOf $jResp "brand.logo.size"]
set v_Url [CkJsonObject_stringOf $jResp "brand.logo.url"]
set Width [CkJsonObject_stringOf $jResp "brand.logo.width"]
set Signature_template [CkJsonObject_stringOf $jResp "brand.signature_template"]
set Ticket_form_ids [CkJsonObject_stringOf $jResp "brand.ticket_form_ids"]
set Updated_at [CkJsonObject_stringOf $jResp "brand.updated_at"]
set brandUrl [CkJsonObject_stringOf $jResp "brand.url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "brand.logo.thumbnails"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set content_type [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].content_type"]
set content_url [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].content_url"]
set deleted [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].deleted"]
set file_name [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].file_name"]
set height [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].height"]
set id [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].id"]
set inline [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].inline"]
set malware_access_override [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].malware_access_override"]
set malware_scan_result [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].malware_scan_result"]
set mapped_content_url [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].mapped_content_url"]
set size [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].size"]
set url [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].url"]
set width [CkJsonObject_stringOf $jResp "brand.logo.thumbnails[i].width"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
}
]
}
