Chilkat Online Tools

Swift3 / Support API / List Trigger Categories

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "login"
    http.password = "password"

    let queryParams = CkoJsonObject()!
    queryParams.update("page[after]", value: "<string>")
    queryParams.update("page[before]", value: "<string>")
    queryParams.update("page[size]", value: "<integer>")
    queryParams.update("sort", value: "-updated_at")
    queryParams.update("include", value: "rule_counts")

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/trigger_categories", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var active_count: String?
    var inactive_count: String?

    var v_Next: String? = jResp.string(of: "links.next")
    var Prev: String? = jResp.string(of: "links.prev")
    var After_cursor: String? = jResp.string(of: "meta.after_cursor")
    var Before_cursor: String? = jResp.string(of: "meta.before_cursor")
    var Has_more: String? = jResp.string(of: "meta.has_more")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "trigger_categories").intValue
    while i < count_i {
        jResp.i = i
        active_count = jResp.string(of: "trigger_categories[i].active_count")
        inactive_count = jResp.string(of: "trigger_categories[i].inactive_count")
        i = i + 1
    }


}

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