Chilkat Online Tools

Xojo / Support API / List Trigger Categories

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("page[after]","<string>")
success = queryParams.UpdateString("page[before]","<string>")
success = queryParams.UpdateString("page[size]","<integer>")
success = queryParams.UpdateString("sort","-updated_at")
success = queryParams.UpdateString("include","rule_counts")

http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/trigger_categories",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim active_count As String
Dim inactive_count As String

Dim v_Next As String
v_Next = jResp.StringOf("links.next")
Dim Prev As String
Prev = jResp.StringOf("links.prev")
Dim After_cursor As String
After_cursor = jResp.StringOf("meta.after_cursor")
Dim Before_cursor As String
Before_cursor = jResp.StringOf("meta.before_cursor")
Dim Has_more As String
Has_more = jResp.StringOf("meta.has_more")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("trigger_categories")
While i < count_i
    jResp.I = i
    active_count = jResp.StringOf("trigger_categories[i].active_count")
    inactive_count = jResp.StringOf("trigger_categories[i].inactive_count")
    i = i + 1
Wend

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}"
    }
  ]
}