Foxpro / Support API / List Brands
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcSubdomain
LOCAL lcActive
LOCAL lcBrand_url
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcHas_help_center
LOCAL lcHelp_center_state
LOCAL lcHost_mapping
LOCAL lcId
LOCAL lcIs_deleted
LOCAL lcContent_type
LOCAL lcContent_url
LOCAL lcDeleted
LOCAL lcFile_name
LOCAL lcHeight
LOCAL lcId
LOCAL lcInline
LOCAL lcMalware_access_override
LOCAL lcMalware_scan_result
LOCAL lcMapped_content_url
LOCAL lcSize
LOCAL lcV_Url
LOCAL lcWidth
LOCAL lcSignature_template
LOCAL lcTicket_form_ids
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL j
LOCAL lnCount_j
LOCAL lcContent_type
LOCAL lcContent_url
LOCAL lcDeleted
LOCAL lcFile_name
LOCAL lcHeight
LOCAL lcInline
LOCAL lcMalware_access_override
LOCAL lcMalware_scan_result
LOCAL lcMapped_content_url
LOCAL lcSize
LOCAL lcWidth
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/brands",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("brands")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("brands[i].name")
lcSubdomain = loJResp.StringOf("brands[i].subdomain")
lcActive = loJResp.StringOf("brands[i].active")
lcBrand_url = loJResp.StringOf("brands[i].brand_url")
lcCreated_at = loJResp.StringOf("brands[i].created_at")
lcDefault = loJResp.StringOf("brands[i].default")
lcHas_help_center = loJResp.StringOf("brands[i].has_help_center")
lcHelp_center_state = loJResp.StringOf("brands[i].help_center_state")
lcHost_mapping = loJResp.StringOf("brands[i].host_mapping")
lcId = loJResp.StringOf("brands[i].id")
lcIs_deleted = loJResp.StringOf("brands[i].is_deleted")
lcContent_type = loJResp.StringOf("brands[i].logo.content_type")
lcContent_url = loJResp.StringOf("brands[i].logo.content_url")
lcDeleted = loJResp.StringOf("brands[i].logo.deleted")
lcFile_name = loJResp.StringOf("brands[i].logo.file_name")
lcHeight = loJResp.StringOf("brands[i].logo.height")
lcId = loJResp.StringOf("brands[i].logo.id")
lcInline = loJResp.StringOf("brands[i].logo.inline")
lcMalware_access_override = loJResp.StringOf("brands[i].logo.malware_access_override")
lcMalware_scan_result = loJResp.StringOf("brands[i].logo.malware_scan_result")
lcMapped_content_url = loJResp.StringOf("brands[i].logo.mapped_content_url")
lcSize = loJResp.StringOf("brands[i].logo.size")
lcV_Url = loJResp.StringOf("brands[i].logo.url")
lcWidth = loJResp.StringOf("brands[i].logo.width")
lcSignature_template = loJResp.StringOf("brands[i].signature_template")
lcTicket_form_ids = loJResp.StringOf("brands[i].ticket_form_ids")
lcUpdated_at = loJResp.StringOf("brands[i].updated_at")
lcUrl = loJResp.StringOf("brands[i].url")
j = 0
lnCount_j = loJResp.SizeOfArray("brands[i].logo.thumbnails")
DO WHILE j < lnCount_j
loJResp.J = j
lcContent_type = loJResp.StringOf("brands[i].logo.thumbnails[j].content_type")
lcContent_url = loJResp.StringOf("brands[i].logo.thumbnails[j].content_url")
lcDeleted = loJResp.StringOf("brands[i].logo.thumbnails[j].deleted")
lcFile_name = loJResp.StringOf("brands[i].logo.thumbnails[j].file_name")
lcHeight = loJResp.StringOf("brands[i].logo.thumbnails[j].height")
lcId = loJResp.StringOf("brands[i].logo.thumbnails[j].id")
lcInline = loJResp.StringOf("brands[i].logo.thumbnails[j].inline")
lcMalware_access_override = loJResp.StringOf("brands[i].logo.thumbnails[j].malware_access_override")
lcMalware_scan_result = loJResp.StringOf("brands[i].logo.thumbnails[j].malware_scan_result")
lcMapped_content_url = loJResp.StringOf("brands[i].logo.thumbnails[j].mapped_content_url")
lcSize = loJResp.StringOf("brands[i].logo.thumbnails[j].size")
lcUrl = loJResp.StringOf("brands[i].logo.thumbnails[j].url")
lcWidth = loJResp.StringOf("brands[i].logo.thumbnails[j].width")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
