Chilkat Online Tools

Swift3 / Support API / List Requests

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"

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

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://example.zendesk.com/api/v2/requests", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

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

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

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "requests": [
    //     {
    //       "subject": "<string>",
    //       "assignee_id": "<integer>",
    //       "can_be_solved_by_me": "<boolean>",
    //       "collaborator_ids": [
    //         "<integer>",
    //         "<integer>"
    //       ],
    //       "created_at": "<dateTime>",
    //       "custom_fields": [
    //         {
    //           "id": "<integer>",
    //           "value": "<string>"
    //         },
    //         {
    //           "id": "<integer>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "custom_status_id": "<integer>",
    //       "description": "<string>",
    //       "due_at": "<dateTime>",
    //       "email_cc_ids": [
    //         "<integer>",
    //         "<integer>"
    //       ],
    //       "followup_source_id": "<integer>",
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "is_public": "<boolean>",
    //       "organization_id": "<integer>",
    //       "priority": "<string>",
    //       "recipient": "<string>",
    //       "requester_id": "<integer>",
    //       "solved": "<boolean>",
    //       "status": "<string>",
    //       "ticket_form_id": "<integer>",
    //       "type": "<string>",
    //       "updated_at": "<dateTime>",
    //       "url": "<string>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "sitde": -5925380.425592765,
    //           "id80": false
    //         }
    //       }
    //     },
    //     {
    //       "subject": "<string>",
    //       "assignee_id": "<integer>",
    //       "can_be_solved_by_me": "<boolean>",
    //       "collaborator_ids": [
    //         "<integer>",
    //         "<integer>"
    //       ],
    //       "created_at": "<dateTime>",
    //       "custom_fields": [
    //         {
    //           "id": "<integer>",
    //           "value": "<string>"
    //         },
    //         {
    //           "id": "<integer>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "custom_status_id": "<integer>",
    //       "description": "<string>",
    //       "due_at": "<dateTime>",
    //       "email_cc_ids": [
    //         "<integer>",
    //         "<integer>"
    //       ],
    //       "followup_source_id": "<integer>",
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "is_public": "<boolean>",
    //       "organization_id": "<integer>",
    //       "priority": "<string>",
    //       "recipient": "<string>",
    //       "requester_id": "<integer>",
    //       "solved": "<boolean>",
    //       "status": "<string>",
    //       "ticket_form_id": "<integer>",
    //       "type": "<string>",
    //       "updated_at": "<dateTime>",
    //       "url": "<string>",
    //       "via": {
    //         "channel": "<string>",
    //         "source": {
    //           "esse2a": false,
    //           "irure_8": true,
    //           "in77": 99886237.33060426,
    //           "nisi_0": "occaecat velit voluptate consequat"
    //         }
    //       }
    //     }
    //   ]
    // }

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

    var subject: String?
    var assignee_id: String?
    var can_be_solved_by_me: String?
    var created_at: String?
    var custom_status_id: String?
    var description: String?
    var due_at: String?
    var followup_source_id: String?
    var group_id: String?
    var id: String?
    var is_public: String?
    var organization_id: String?
    var priority: String?
    var recipient: String?
    var requester_id: String?
    var solved: String?
    var status: String?
    var ticket_form_id: String?
    var v_type: String?
    var updated_at: String?
    var url: String?
    var Channel: String?
    var Sitde: String?
    var Id80: Bool
    var Esse2a: Bool
    var Irure_8: Bool
    var In77: String?
    var Nisi_0: String?
    var j: Int
    var count_j: Int
    var strVal: String?
    var value: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "requests").intValue
    while i < count_i {
        jResp.i = i
        subject = jResp.string(of: "requests[i].subject")
        assignee_id = jResp.string(of: "requests[i].assignee_id")
        can_be_solved_by_me = jResp.string(of: "requests[i].can_be_solved_by_me")
        created_at = jResp.string(of: "requests[i].created_at")
        custom_status_id = jResp.string(of: "requests[i].custom_status_id")
        description = jResp.string(of: "requests[i].description")
        due_at = jResp.string(of: "requests[i].due_at")
        followup_source_id = jResp.string(of: "requests[i].followup_source_id")
        group_id = jResp.string(of: "requests[i].group_id")
        id = jResp.string(of: "requests[i].id")
        is_public = jResp.string(of: "requests[i].is_public")
        organization_id = jResp.string(of: "requests[i].organization_id")
        priority = jResp.string(of: "requests[i].priority")
        recipient = jResp.string(of: "requests[i].recipient")
        requester_id = jResp.string(of: "requests[i].requester_id")
        solved = jResp.string(of: "requests[i].solved")
        status = jResp.string(of: "requests[i].status")
        ticket_form_id = jResp.string(of: "requests[i].ticket_form_id")
        v_type = jResp.string(of: "requests[i].type")
        updated_at = jResp.string(of: "requests[i].updated_at")
        url = jResp.string(of: "requests[i].url")
        Channel = jResp.string(of: "requests[i].via.channel")
        Sitde = jResp.string(of: "requests[i].via.source.sitde")
        Id80 = jResp.bool(of: "requests[i].via.source.id80")
        Esse2a = jResp.bool(of: "requests[i].via.source.esse2a")
        Irure_8 = jResp.bool(of: "requests[i].via.source.irure_8")
        In77 = jResp.string(of: "requests[i].via.source.in77")
        Nisi_0 = jResp.string(of: "requests[i].via.source.nisi_0")
        j = 0
        count_j = jResp.size(ofArray: "requests[i].collaborator_ids").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "requests[i].collaborator_ids[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "requests[i].custom_fields").intValue
        while j < count_j {
            jResp.j = j
            id = jResp.string(of: "requests[i].custom_fields[j].id")
            value = jResp.string(of: "requests[i].custom_fields[j].value")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "requests[i].email_cc_ids").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "requests[i].email_cc_ids[j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests

Postman Collection Item JSON

{
  "name": "List Requests",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests"
      ],
      "variable": [
        {
          "key": "sort_by",
          "value": "<string>",
          "description": "Possible values are \"updated_at\", \"created_at\""
        },
        {
          "key": "sort_order",
          "value": "<string>",
          "description": "One of \"asc\", \"desc\". Defaults to \"asc\""
        }
      ]
    },
    "description": "#### Allowed for\n\n* End Users\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/requests",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"requests\": [\n    {\n      \"subject\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"can_be_solved_by_me\": \"<boolean>\",\n      \"collaborator_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": [\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"followup_source_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester_id\": \"<integer>\",\n      \"solved\": \"<boolean>\",\n      \"status\": \"<string>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"sitde\": -5925380.425592765,\n          \"id80\": false\n        }\n      }\n    },\n    {\n      \"subject\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"can_be_solved_by_me\": \"<boolean>\",\n      \"collaborator_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": [\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"followup_source_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester_id\": \"<integer>\",\n      \"solved\": \"<boolean>\",\n      \"status\": \"<string>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"esse2a\": false,\n          \"irure_8\": true,\n          \"in77\": 99886237.33060426,\n          \"nisi_0\": \"occaecat velit voluptate consequat\"\n        }\n      }\n    }\n  ]\n}"
    }
  ]
}