SQL Server / Support API / List Brands
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/brands', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
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
DECLARE @name nvarchar(4000)
DECLARE @subdomain nvarchar(4000)
DECLARE @active nvarchar(4000)
DECLARE @brand_url nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @default nvarchar(4000)
DECLARE @has_help_center nvarchar(4000)
DECLARE @help_center_state nvarchar(4000)
DECLARE @host_mapping nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @is_deleted nvarchar(4000)
DECLARE @Content_type nvarchar(4000)
DECLARE @Content_url nvarchar(4000)
DECLARE @Deleted nvarchar(4000)
DECLARE @File_name nvarchar(4000)
DECLARE @Height nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @Inline nvarchar(4000)
DECLARE @Malware_access_override nvarchar(4000)
DECLARE @Malware_scan_result nvarchar(4000)
DECLARE @Mapped_content_url nvarchar(4000)
DECLARE @Size nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
DECLARE @Width nvarchar(4000)
DECLARE @signature_template nvarchar(4000)
DECLARE @ticket_form_ids nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @content_type nvarchar(4000)
DECLARE @content_url nvarchar(4000)
DECLARE @deleted nvarchar(4000)
DECLARE @file_name nvarchar(4000)
DECLARE @height nvarchar(4000)
DECLARE @inline nvarchar(4000)
DECLARE @malware_access_override nvarchar(4000)
DECLARE @malware_scan_result nvarchar(4000)
DECLARE @mapped_content_url nvarchar(4000)
DECLARE @size nvarchar(4000)
DECLARE @width nvarchar(4000)
DECLARE @count nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @count OUT, 'count'
DECLARE @next_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @next_page OUT, 'next_page'
DECLARE @previous_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previous_page OUT, 'previous_page'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'brands'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'brands[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @subdomain OUT, 'brands[i].subdomain'
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'brands[i].active'
EXEC sp_OAMethod @jResp, 'StringOf', @brand_url OUT, 'brands[i].brand_url'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'brands[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @default OUT, 'brands[i].default'
EXEC sp_OAMethod @jResp, 'StringOf', @has_help_center OUT, 'brands[i].has_help_center'
EXEC sp_OAMethod @jResp, 'StringOf', @help_center_state OUT, 'brands[i].help_center_state'
EXEC sp_OAMethod @jResp, 'StringOf', @host_mapping OUT, 'brands[i].host_mapping'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'brands[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @is_deleted OUT, 'brands[i].is_deleted'
EXEC sp_OAMethod @jResp, 'StringOf', @Content_type OUT, 'brands[i].logo.content_type'
EXEC sp_OAMethod @jResp, 'StringOf', @Content_url OUT, 'brands[i].logo.content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @Deleted OUT, 'brands[i].logo.deleted'
EXEC sp_OAMethod @jResp, 'StringOf', @File_name OUT, 'brands[i].logo.file_name'
EXEC sp_OAMethod @jResp, 'StringOf', @Height OUT, 'brands[i].logo.height'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'brands[i].logo.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Inline OUT, 'brands[i].logo.inline'
EXEC sp_OAMethod @jResp, 'StringOf', @Malware_access_override OUT, 'brands[i].logo.malware_access_override'
EXEC sp_OAMethod @jResp, 'StringOf', @Malware_scan_result OUT, 'brands[i].logo.malware_scan_result'
EXEC sp_OAMethod @jResp, 'StringOf', @Mapped_content_url OUT, 'brands[i].logo.mapped_content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @Size OUT, 'brands[i].logo.size'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'brands[i].logo.url'
EXEC sp_OAMethod @jResp, 'StringOf', @Width OUT, 'brands[i].logo.width'
EXEC sp_OAMethod @jResp, 'StringOf', @signature_template OUT, 'brands[i].signature_template'
EXEC sp_OAMethod @jResp, 'StringOf', @ticket_form_ids OUT, 'brands[i].ticket_form_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'brands[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'brands[i].url'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'brands[i].logo.thumbnails'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @content_type OUT, 'brands[i].logo.thumbnails[j].content_type'
EXEC sp_OAMethod @jResp, 'StringOf', @content_url OUT, 'brands[i].logo.thumbnails[j].content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @deleted OUT, 'brands[i].logo.thumbnails[j].deleted'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'brands[i].logo.thumbnails[j].file_name'
EXEC sp_OAMethod @jResp, 'StringOf', @height OUT, 'brands[i].logo.thumbnails[j].height'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'brands[i].logo.thumbnails[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @inline OUT, 'brands[i].logo.thumbnails[j].inline'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_access_override OUT, 'brands[i].logo.thumbnails[j].malware_access_override'
EXEC sp_OAMethod @jResp, 'StringOf', @malware_scan_result OUT, 'brands[i].logo.thumbnails[j].malware_scan_result'
EXEC sp_OAMethod @jResp, 'StringOf', @mapped_content_url OUT, 'brands[i].logo.thumbnails[j].mapped_content_url'
EXEC sp_OAMethod @jResp, 'StringOf', @size OUT, 'brands[i].logo.thumbnails[j].size'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'brands[i].logo.thumbnails[j].url'
EXEC sp_OAMethod @jResp, 'StringOf', @width OUT, 'brands[i].logo.thumbnails[j].width'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
