PureBasic / Support API / List Trigger Categories
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"page[after]","<string>")
CkJsonObject::ckUpdateString(queryParams,"page[before]","<string>")
CkJsonObject::ckUpdateString(queryParams,"page[size]","<integer>")
CkJsonObject::ckUpdateString(queryParams,"sort","-updated_at")
CkJsonObject::ckUpdateString(queryParams,"include","rule_counts")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/trigger_categories",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "trigger_categories": [
; {
; "active_count": "<long>",
; "inactive_count": "<long>"
; },
; {
; "active_count": "<long>",
; "inactive_count": "<long>"
; }
; ],
; "links": {
; "next": "<string>",
; "prev": "<string>"
; },
; "meta": {
; "after_cursor": "<string>",
; "before_cursor": "<string>",
; "has_more": "<boolean>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
active_count.s
inactive_count.s
v_Next.s = CkJsonObject::ckStringOf(jResp,"links.next")
Prev.s = CkJsonObject::ckStringOf(jResp,"links.prev")
After_cursor.s = CkJsonObject::ckStringOf(jResp,"meta.after_cursor")
Before_cursor.s = CkJsonObject::ckStringOf(jResp,"meta.before_cursor")
Has_more.s = CkJsonObject::ckStringOf(jResp,"meta.has_more")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"trigger_categories")
While i < count_i
CkJsonObject::setCkI(jResp, i)
active_count = CkJsonObject::ckStringOf(jResp,"trigger_categories[i].active_count")
inactive_count = CkJsonObject::ckStringOf(jResp,"trigger_categories[i].inactive_count")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -G -d "page[after]=%3Cstring%3E"
-d "page[before]=%3Cstring%3E"
-d "page[size]=%3Cinteger%3E"
-d "sort=-updated_at"
-d "include=rule_counts"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/trigger_categories
Postman Collection Item JSON
{
"name": "List Trigger Categories",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
},
"description": "Returns all the trigger categories in the account."
},
"response": [
{
"name": "A paged array of trigger categories",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger_categories\": [\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n },\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n }\n ],\n \"links\": {\n \"next\": \"<string>\",\n \"prev\": \"<string>\"\n },\n \"meta\": {\n \"after_cursor\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"has_more\": \"<boolean>\"\n }\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
