PureBasic / Support API / List Brands
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/brands",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
name.s
subdomain.s
active.s
brand_url.s
created_at.s
default.s
has_help_center.s
help_center_state.s
host_mapping.s
id.s
is_deleted.s
Content_type.s
Content_url.s
Deleted.s
File_name.s
Height.s
Id.s
Inline.s
Malware_access_override.s
Malware_scan_result.s
Mapped_content_url.s
Size.s
v_Url.s
Width.s
signature_template.s
ticket_form_ids.s
updated_at.s
url.s
j.i
count_j.i
content_type.s
content_url.s
deleted.s
file_name.s
height.s
inline.s
malware_access_override.s
malware_scan_result.s
mapped_content_url.s
size.s
width.s
count.s = CkJsonObject::ckStringOf(jResp,"count")
next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"brands")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"brands[i].name")
subdomain = CkJsonObject::ckStringOf(jResp,"brands[i].subdomain")
active = CkJsonObject::ckStringOf(jResp,"brands[i].active")
brand_url = CkJsonObject::ckStringOf(jResp,"brands[i].brand_url")
created_at = CkJsonObject::ckStringOf(jResp,"brands[i].created_at")
default = CkJsonObject::ckStringOf(jResp,"brands[i].default")
has_help_center = CkJsonObject::ckStringOf(jResp,"brands[i].has_help_center")
help_center_state = CkJsonObject::ckStringOf(jResp,"brands[i].help_center_state")
host_mapping = CkJsonObject::ckStringOf(jResp,"brands[i].host_mapping")
id = CkJsonObject::ckStringOf(jResp,"brands[i].id")
is_deleted = CkJsonObject::ckStringOf(jResp,"brands[i].is_deleted")
Content_type = CkJsonObject::ckStringOf(jResp,"brands[i].logo.content_type")
Content_url = CkJsonObject::ckStringOf(jResp,"brands[i].logo.content_url")
Deleted = CkJsonObject::ckStringOf(jResp,"brands[i].logo.deleted")
File_name = CkJsonObject::ckStringOf(jResp,"brands[i].logo.file_name")
Height = CkJsonObject::ckStringOf(jResp,"brands[i].logo.height")
Id = CkJsonObject::ckStringOf(jResp,"brands[i].logo.id")
Inline = CkJsonObject::ckStringOf(jResp,"brands[i].logo.inline")
Malware_access_override = CkJsonObject::ckStringOf(jResp,"brands[i].logo.malware_access_override")
Malware_scan_result = CkJsonObject::ckStringOf(jResp,"brands[i].logo.malware_scan_result")
Mapped_content_url = CkJsonObject::ckStringOf(jResp,"brands[i].logo.mapped_content_url")
Size = CkJsonObject::ckStringOf(jResp,"brands[i].logo.size")
v_Url = CkJsonObject::ckStringOf(jResp,"brands[i].logo.url")
Width = CkJsonObject::ckStringOf(jResp,"brands[i].logo.width")
signature_template = CkJsonObject::ckStringOf(jResp,"brands[i].signature_template")
ticket_form_ids = CkJsonObject::ckStringOf(jResp,"brands[i].ticket_form_ids")
updated_at = CkJsonObject::ckStringOf(jResp,"brands[i].updated_at")
url = CkJsonObject::ckStringOf(jResp,"brands[i].url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"brands[i].logo.thumbnails")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
content_type = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].content_type")
content_url = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].content_url")
deleted = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].deleted")
file_name = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].file_name")
height = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].height")
id = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].id")
inline = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].inline")
malware_access_override = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].malware_access_override")
malware_scan_result = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].malware_scan_result")
mapped_content_url = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].mapped_content_url")
size = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].size")
url = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].url")
width = CkJsonObject::ckStringOf(jResp,"brands[i].logo.thumbnails[j].width")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
