Chilkat Online Tools

Swift3 / Support API / List Custom Ticket Statuses

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("status_categories", value: "<string>")
    queryParams.update("active", value: "<boolean>")
    queryParams.update("default", value: "<boolean>")

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

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/custom_statuses", 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)

    // {
    //   "custom_statuses": [
    //     {
    //       "status_category": "pending",
    //       "agent_label": "<string>",
    //       "active": "<boolean>",
    //       "created_at": "<dateTime>",
    //       "default": "<boolean>",
    //       "description": "<string>",
    //       "end_user_description": "<string>",
    //       "end_user_label": "<string>",
    //       "id": "<integer>",
    //       "raw_agent_label": "<string>",
    //       "raw_description": "<string>",
    //       "raw_end_user_description": "<string>",
    //       "raw_end_user_label": "<string>",
    //       "updated_at": "<dateTime>"
    //     },
    //     {
    //       "status_category": "hold",
    //       "agent_label": "<string>",
    //       "active": "<boolean>",
    //       "created_at": "<dateTime>",
    //       "default": "<boolean>",
    //       "description": "<string>",
    //       "end_user_description": "<string>",
    //       "end_user_label": "<string>",
    //       "id": "<integer>",
    //       "raw_agent_label": "<string>",
    //       "raw_description": "<string>",
    //       "raw_end_user_description": "<string>",
    //       "raw_end_user_label": "<string>",
    //       "updated_at": "<dateTime>"
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var status_category: String?
    var agent_label: String?
    var active: String?
    var created_at: String?
    var default: String?
    var description: String?
    var end_user_description: String?
    var end_user_label: String?
    var id: String?
    var raw_agent_label: String?
    var raw_description: String?
    var raw_end_user_description: String?
    var raw_end_user_label: String?
    var updated_at: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "custom_statuses").intValue
    while i < count_i {
        jResp.i = i
        status_category = jResp.string(of: "custom_statuses[i].status_category")
        agent_label = jResp.string(of: "custom_statuses[i].agent_label")
        active = jResp.string(of: "custom_statuses[i].active")
        created_at = jResp.string(of: "custom_statuses[i].created_at")
        default = jResp.string(of: "custom_statuses[i].default")
        description = jResp.string(of: "custom_statuses[i].description")
        end_user_description = jResp.string(of: "custom_statuses[i].end_user_description")
        end_user_label = jResp.string(of: "custom_statuses[i].end_user_label")
        id = jResp.string(of: "custom_statuses[i].id")
        raw_agent_label = jResp.string(of: "custom_statuses[i].raw_agent_label")
        raw_description = jResp.string(of: "custom_statuses[i].raw_description")
        raw_end_user_description = jResp.string(of: "custom_statuses[i].raw_end_user_description")
        raw_end_user_label = jResp.string(of: "custom_statuses[i].raw_end_user_label")
        updated_at = jResp.string(of: "custom_statuses[i].updated_at")
        i = i + 1
    }


}

Curl Command

curl  -u login:password -G -d "status_categories=%3Cstring%3E"
	-d "active=%3Cboolean%3E"
	-d "default=%3Cboolean%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_statuses

Postman Collection Item JSON

{
  "name": "List Custom Ticket Statuses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses?status_categories=<string>&active=<boolean>&default=<boolean>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses"
      ],
      "query": [
        {
          "key": "status_categories",
          "value": "<string>",
          "description": "Filter the list of custom ticket statuses by a comma-separated list of status categories"
        },
        {
          "key": "active",
          "value": "<boolean>",
          "description": "If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses"
        },
        {
          "key": "default",
          "value": "<boolean>",
          "description": "If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses"
        }
      ]
    },
    "description": "Lists all undeleted custom ticket statuses for the account. No pagination is provided.\n\n#### Allowed For\n\n* End Users\n"
  },
  "response": [
    {
      "name": "List custom ticket statuses",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses?status_categories=<string>&active=<boolean>&default=<boolean>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses"
          ],
          "query": [
            {
              "key": "status_categories",
              "value": "<string>",
              "description": "Filter the list of custom ticket statuses by a comma-separated list of status categories"
            },
            {
              "key": "active",
              "value": "<boolean>",
              "description": "If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses"
            },
            {
              "key": "default",
              "value": "<boolean>",
              "description": "If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_statuses\": [\n    {\n      \"status_category\": \"pending\",\n      \"agent_label\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"end_user_description\": \"<string>\",\n      \"end_user_label\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"raw_agent_label\": \"<string>\",\n      \"raw_description\": \"<string>\",\n      \"raw_end_user_description\": \"<string>\",\n      \"raw_end_user_label\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"status_category\": \"hold\",\n      \"agent_label\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"end_user_description\": \"<string>\",\n      \"end_user_label\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"raw_agent_label\": \"<string>\",\n      \"raw_description\": \"<string>\",\n      \"raw_end_user_description\": \"<string>\",\n      \"raw_end_user_label\": \"<string>\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ]\n}"
    }
  ]
}