DataFlex / Support API / List Brands
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sSubdomain
String sActive
String sBrand_url
String sCreated_at
String sDefault
String sHas_help_center
String sHelp_center_state
String sHost_mapping
String sId
String sIs_deleted
String sContent_type
String sContent_url
String sDeleted
String sFile_name
String sHeight
String sId
String sInline
String sMalware_access_override
String sMalware_scan_result
String sMapped_content_url
String sSize
String sV_Url
String sWidth
String sSignature_template
String sTicket_form_ids
String sUpdated_at
String sUrl
Integer j
Integer iCount_j
String sContent_type
String sContent_url
String sDeleted
String sFile_name
String sHeight
String sInline
String sMalware_access_override
String sMalware_scan_result
String sMapped_content_url
String sSize
String sWidth
String sCount
String sNext_page
String sPrevious_page
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://example.zendesk.com/api/v2/brands" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "count" To sCount
Get ComStringOf Of hoJResp "next_page" To sNext_page
Get ComStringOf Of hoJResp "previous_page" To sPrevious_page
Move 0 To i
Get ComSizeOfArray Of hoJResp "brands" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "brands[i].name" To sName
Get ComStringOf Of hoJResp "brands[i].subdomain" To sSubdomain
Get ComStringOf Of hoJResp "brands[i].active" To sActive
Get ComStringOf Of hoJResp "brands[i].brand_url" To sBrand_url
Get ComStringOf Of hoJResp "brands[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "brands[i].default" To sDefault
Get ComStringOf Of hoJResp "brands[i].has_help_center" To sHas_help_center
Get ComStringOf Of hoJResp "brands[i].help_center_state" To sHelp_center_state
Get ComStringOf Of hoJResp "brands[i].host_mapping" To sHost_mapping
Get ComStringOf Of hoJResp "brands[i].id" To sId
Get ComStringOf Of hoJResp "brands[i].is_deleted" To sIs_deleted
Get ComStringOf Of hoJResp "brands[i].logo.content_type" To sContent_type
Get ComStringOf Of hoJResp "brands[i].logo.content_url" To sContent_url
Get ComStringOf Of hoJResp "brands[i].logo.deleted" To sDeleted
Get ComStringOf Of hoJResp "brands[i].logo.file_name" To sFile_name
Get ComStringOf Of hoJResp "brands[i].logo.height" To sHeight
Get ComStringOf Of hoJResp "brands[i].logo.id" To sId
Get ComStringOf Of hoJResp "brands[i].logo.inline" To sInline
Get ComStringOf Of hoJResp "brands[i].logo.malware_access_override" To sMalware_access_override
Get ComStringOf Of hoJResp "brands[i].logo.malware_scan_result" To sMalware_scan_result
Get ComStringOf Of hoJResp "brands[i].logo.mapped_content_url" To sMapped_content_url
Get ComStringOf Of hoJResp "brands[i].logo.size" To sSize
Get ComStringOf Of hoJResp "brands[i].logo.url" To sV_Url
Get ComStringOf Of hoJResp "brands[i].logo.width" To sWidth
Get ComStringOf Of hoJResp "brands[i].signature_template" To sSignature_template
Get ComStringOf Of hoJResp "brands[i].ticket_form_ids" To sTicket_form_ids
Get ComStringOf Of hoJResp "brands[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "brands[i].url" To sUrl
Move 0 To j
Get ComSizeOfArray Of hoJResp "brands[i].logo.thumbnails" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].content_type" To sContent_type
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].content_url" To sContent_url
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].deleted" To sDeleted
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].file_name" To sFile_name
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].height" To sHeight
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].id" To sId
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].inline" To sInline
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].malware_access_override" To sMalware_access_override
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].malware_scan_result" To sMalware_scan_result
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].mapped_content_url" To sMapped_content_url
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].size" To sSize
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].url" To sUrl
Get ComStringOf Of hoJResp "brands[i].logo.thumbnails[j].width" To sWidth
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
