Chilkat Online Tools

Swift3 / Support API / List Bookmarks

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/bookmarks", 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)

    // {
    //   "count": "<integer>",
    //   "next_page": "<string>",
    //   "previous_page": "<string>",
    //   "bookmarks": [
    //     {
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "ticket": {
    //         "requester_id": "<integer>",
    //         "allow_attachments": "<boolean>",
    //         "allow_channelback": "<boolean>",
    //         "assignee_email": "<string>",
    //         "assignee_id": "<integer>",
    //         "attribute_value_ids": "<array>",
    //         "brand_id": "<integer>",
    //         "collaborator_ids": "<array>",
    //         "collaborators": [
    //           {
    //             "email": "<email>",
    //             "name": "<string>"
    //           },
    //           {
    //             "email": "<email>",
    //             "name": "<string>"
    //           }
    //         ],
    //         "comment": {},
    //         "created_at": "<dateTime>",
    //         "custom_fields": "<array>",
    //         "custom_status_id": "<integer>",
    //         "description": "<string>",
    //         "due_at": "<dateTime>",
    //         "email_cc_ids": "<array>",
    //         "email_ccs": {},
    //         "external_id": "<string>",
    //         "follower_ids": "<array>",
    //         "followers": {},
    //         "followup_ids": "<array>",
    //         "forum_topic_id": "<integer>",
    //         "from_messaging_channel": "<boolean>",
    //         "group_id": "<integer>",
    //         "has_incidents": "<boolean>",
    //         "id": "<integer>",
    //         "is_public": "<boolean>",
    //         "macro_id": "<integer>",
    //         "macro_ids": "<array>",
    //         "metadata": {},
    //         "organization_id": "<integer>",
    //         "priority": "normal",
    //         "problem_id": "<integer>",
    //         "raw_subject": "<string>",
    //         "recipient": "<string>",
    //         "requester": {},
    //         "safe_update": "<boolean>",
    //         "satisfaction_rating": {
    //           "qui_c2": "laboris in reprehenderit pariatur",
    //           "elit_74": 85725084.5127286
    //         },
    //         "sharing_agreement_ids": "<array>",
    //         "status": "solved",
    //         "subject": "<string>",
    //         "submitter_id": "<integer>",
    //         "tags": "<array>",
    //         "ticket_form_id": "<integer>",
    //         "type": "question",
    //         "updated_at": "<dateTime>",
    //         "updated_stamp": "<string>",
    //         "url": "<string>",
    //         "via": {
    //           "channel": "<string>",
    //           "source": {
    //             "ad_58d": "ex Duis est"
    //           }
    //         },
    //         "via_followup_source_id": "<integer>",
    //         "via_id": "<integer>",
    //         "voice_comment": {}
    //       },
    //       "url": "<string>"
    //     },
    //     {
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "ticket": {
    //         "requester_id": "<integer>",
    //         "allow_attachments": "<boolean>",
    //         "allow_channelback": "<boolean>",
    //         "assignee_email": "<string>",
    //         "assignee_id": "<integer>",
    //         "attribute_value_ids": "<array>",
    //         "brand_id": "<integer>",
    //         "collaborator_ids": "<array>",
    //         "collaborators": [
    //           {
    //             "email": "<email>",
    //             "name": "<string>"
    //           },
    //           {
    //             "email": "<email>",
    //             "name": "<string>"
    //           }
    //         ],
    //         "comment": {},
    //         "created_at": "<dateTime>",
    //         "custom_fields": "<array>",
    //         "custom_status_id": "<integer>",
    //         "description": "<string>",
    //         "due_at": "<dateTime>",
    //         "email_cc_ids": "<array>",
    //         "email_ccs": {},
    //         "external_id": "<string>",
    //         "follower_ids": "<array>",
    //         "followers": {},
    //         "followup_ids": "<array>",
    //         "forum_topic_id": "<integer>",
    //         "from_messaging_channel": "<boolean>",
    //         "group_id": "<integer>",
    //         "has_incidents": "<boolean>",
    //         "id": "<integer>",
    //         "is_public": "<boolean>",
    //         "macro_id": "<integer>",
    //         "macro_ids": "<array>",
    //         "metadata": {},
    //         "organization_id": "<integer>",
    //         "priority": "low",
    //         "problem_id": "<integer>",
    //         "raw_subject": "<string>",
    //         "recipient": "<string>",
    //         "requester": {},
    //         "safe_update": "<boolean>",
    //         "satisfaction_rating": {
    //           "dolor3b": true,
    //           "nonc7": false
    //         },
    //         "sharing_agreement_ids": "<array>",
    //         "status": "solved",
    //         "subject": "<string>",
    //         "submitter_id": "<integer>",
    //         "tags": "<array>",
    //         "ticket_form_id": "<integer>",
    //         "type": "task",
    //         "updated_at": "<dateTime>",
    //         "updated_stamp": "<string>",
    //         "url": "<string>",
    //         "via": {
    //           "channel": "<string>",
    //           "source": {
    //             "exercitation_19": "incididunt tempor minim",
    //             "proident_0": "proident qui ullamco"
    //           }
    //         },
    //         "via_followup_source_id": "<integer>",
    //         "via_id": "<integer>",
    //         "voice_comment": {}
    //       },
    //       "url": "<string>"
    //     }
    //   ]
    // }

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

    var created_at: String?
    var id: String?
    var Requester_id: String?
    var Allow_attachments: String?
    var Allow_channelback: String?
    var Assignee_email: String?
    var Assignee_id: String?
    var Attribute_value_ids: String?
    var Brand_id: String?
    var Collaborator_ids: String?
    var Created_at: String?
    var Custom_fields: String?
    var Custom_status_id: String?
    var Description: String?
    var Due_at: String?
    var Email_cc_ids: String?
    var External_id: String?
    var Follower_ids: String?
    var Followup_ids: String?
    var Forum_topic_id: String?
    var From_messaging_channel: String?
    var Group_id: String?
    var Has_incidents: String?
    var Id: String?
    var Is_public: String?
    var Macro_id: String?
    var Macro_ids: String?
    var Organization_id: String?
    var Priority: String?
    var Problem_id: String?
    var Raw_subject: String?
    var Recipient: String?
    var Safe_update: String?
    var Qui_c2: String?
    var Elit_74: String?
    var Sharing_agreement_ids: String?
    var Status: String?
    var Subject: String?
    var Submitter_id: String?
    var Tags: String?
    var Ticket_form_id: String?
    var v_Type: String?
    var Updated_at: String?
    var Updated_stamp: String?
    var v_Url: String?
    var Channel: String?
    var Ad_58d: String?
    var Via_followup_source_id: String?
    var Via_id: String?
    var url: String?
    var Dolor3b: Bool
    var Nonc7: Bool
    var Exercitation_19: String?
    var Proident_0: String?
    var j: Int
    var count_j: Int
    var email: String?
    var name: String?

    var count: String? = jResp.string(of: "count")
    var next_page: String? = jResp.string(of: "next_page")
    var previous_page: String? = jResp.string(of: "previous_page")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "bookmarks").intValue
    while i < count_i {
        jResp.i = i
        created_at = jResp.string(of: "bookmarks[i].created_at")
        id = jResp.string(of: "bookmarks[i].id")
        Requester_id = jResp.string(of: "bookmarks[i].ticket.requester_id")
        Allow_attachments = jResp.string(of: "bookmarks[i].ticket.allow_attachments")
        Allow_channelback = jResp.string(of: "bookmarks[i].ticket.allow_channelback")
        Assignee_email = jResp.string(of: "bookmarks[i].ticket.assignee_email")
        Assignee_id = jResp.string(of: "bookmarks[i].ticket.assignee_id")
        Attribute_value_ids = jResp.string(of: "bookmarks[i].ticket.attribute_value_ids")
        Brand_id = jResp.string(of: "bookmarks[i].ticket.brand_id")
        Collaborator_ids = jResp.string(of: "bookmarks[i].ticket.collaborator_ids")
        Created_at = jResp.string(of: "bookmarks[i].ticket.created_at")
        Custom_fields = jResp.string(of: "bookmarks[i].ticket.custom_fields")
        Custom_status_id = jResp.string(of: "bookmarks[i].ticket.custom_status_id")
        Description = jResp.string(of: "bookmarks[i].ticket.description")
        Due_at = jResp.string(of: "bookmarks[i].ticket.due_at")
        Email_cc_ids = jResp.string(of: "bookmarks[i].ticket.email_cc_ids")
        External_id = jResp.string(of: "bookmarks[i].ticket.external_id")
        Follower_ids = jResp.string(of: "bookmarks[i].ticket.follower_ids")
        Followup_ids = jResp.string(of: "bookmarks[i].ticket.followup_ids")
        Forum_topic_id = jResp.string(of: "bookmarks[i].ticket.forum_topic_id")
        From_messaging_channel = jResp.string(of: "bookmarks[i].ticket.from_messaging_channel")
        Group_id = jResp.string(of: "bookmarks[i].ticket.group_id")
        Has_incidents = jResp.string(of: "bookmarks[i].ticket.has_incidents")
        Id = jResp.string(of: "bookmarks[i].ticket.id")
        Is_public = jResp.string(of: "bookmarks[i].ticket.is_public")
        Macro_id = jResp.string(of: "bookmarks[i].ticket.macro_id")
        Macro_ids = jResp.string(of: "bookmarks[i].ticket.macro_ids")
        Organization_id = jResp.string(of: "bookmarks[i].ticket.organization_id")
        Priority = jResp.string(of: "bookmarks[i].ticket.priority")
        Problem_id = jResp.string(of: "bookmarks[i].ticket.problem_id")
        Raw_subject = jResp.string(of: "bookmarks[i].ticket.raw_subject")
        Recipient = jResp.string(of: "bookmarks[i].ticket.recipient")
        Safe_update = jResp.string(of: "bookmarks[i].ticket.safe_update")
        Qui_c2 = jResp.string(of: "bookmarks[i].ticket.satisfaction_rating.qui_c2")
        Elit_74 = jResp.string(of: "bookmarks[i].ticket.satisfaction_rating.elit_74")
        Sharing_agreement_ids = jResp.string(of: "bookmarks[i].ticket.sharing_agreement_ids")
        Status = jResp.string(of: "bookmarks[i].ticket.status")
        Subject = jResp.string(of: "bookmarks[i].ticket.subject")
        Submitter_id = jResp.string(of: "bookmarks[i].ticket.submitter_id")
        Tags = jResp.string(of: "bookmarks[i].ticket.tags")
        Ticket_form_id = jResp.string(of: "bookmarks[i].ticket.ticket_form_id")
        v_Type = jResp.string(of: "bookmarks[i].ticket.type")
        Updated_at = jResp.string(of: "bookmarks[i].ticket.updated_at")
        Updated_stamp = jResp.string(of: "bookmarks[i].ticket.updated_stamp")
        v_Url = jResp.string(of: "bookmarks[i].ticket.url")
        Channel = jResp.string(of: "bookmarks[i].ticket.via.channel")
        Ad_58d = jResp.string(of: "bookmarks[i].ticket.via.source.ad_58d")
        Via_followup_source_id = jResp.string(of: "bookmarks[i].ticket.via_followup_source_id")
        Via_id = jResp.string(of: "bookmarks[i].ticket.via_id")
        url = jResp.string(of: "bookmarks[i].url")
        Dolor3b = jResp.bool(of: "bookmarks[i].ticket.satisfaction_rating.dolor3b")
        Nonc7 = jResp.bool(of: "bookmarks[i].ticket.satisfaction_rating.nonc7")
        Exercitation_19 = jResp.string(of: "bookmarks[i].ticket.via.source.exercitation_19")
        Proident_0 = jResp.string(of: "bookmarks[i].ticket.via.source.proident_0")
        j = 0
        count_j = jResp.size(ofArray: "bookmarks[i].ticket.collaborators").intValue
        while j < count_j {
            jResp.j = j
            email = jResp.string(of: "bookmarks[i].ticket.collaborators[j].email")
            name = jResp.string(of: "bookmarks[i].ticket.collaborators[j].name")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Bookmarks",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/bookmarks",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "bookmarks"
      ]
    },
    "description": "#### Allowed For\n- Agents"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/bookmarks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "bookmarks"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\",\n  \"bookmarks\": [\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"ticket\": {\n        \"requester_id\": \"<integer>\",\n        \"allow_attachments\": \"<boolean>\",\n        \"allow_channelback\": \"<boolean>\",\n        \"assignee_email\": \"<string>\",\n        \"assignee_id\": \"<integer>\",\n        \"attribute_value_ids\": \"<array>\",\n        \"brand_id\": \"<integer>\",\n        \"collaborator_ids\": \"<array>\",\n        \"collaborators\": [\n          {\n            \"email\": \"<email>\",\n            \"name\": \"<string>\"\n          },\n          {\n            \"email\": \"<email>\",\n            \"name\": \"<string>\"\n          }\n        ],\n        \"comment\": {},\n        \"created_at\": \"<dateTime>\",\n        \"custom_fields\": \"<array>\",\n        \"custom_status_id\": \"<integer>\",\n        \"description\": \"<string>\",\n        \"due_at\": \"<dateTime>\",\n        \"email_cc_ids\": \"<array>\",\n        \"email_ccs\": {},\n        \"external_id\": \"<string>\",\n        \"follower_ids\": \"<array>\",\n        \"followers\": {},\n        \"followup_ids\": \"<array>\",\n        \"forum_topic_id\": \"<integer>\",\n        \"from_messaging_channel\": \"<boolean>\",\n        \"group_id\": \"<integer>\",\n        \"has_incidents\": \"<boolean>\",\n        \"id\": \"<integer>\",\n        \"is_public\": \"<boolean>\",\n        \"macro_id\": \"<integer>\",\n        \"macro_ids\": \"<array>\",\n        \"metadata\": {},\n        \"organization_id\": \"<integer>\",\n        \"priority\": \"normal\",\n        \"problem_id\": \"<integer>\",\n        \"raw_subject\": \"<string>\",\n        \"recipient\": \"<string>\",\n        \"requester\": {},\n        \"safe_update\": \"<boolean>\",\n        \"satisfaction_rating\": {\n          \"qui_c2\": \"laboris in reprehenderit pariatur\",\n          \"elit_74\": 85725084.5127286\n        },\n        \"sharing_agreement_ids\": \"<array>\",\n        \"status\": \"solved\",\n        \"subject\": \"<string>\",\n        \"submitter_id\": \"<integer>\",\n        \"tags\": \"<array>\",\n        \"ticket_form_id\": \"<integer>\",\n        \"type\": \"question\",\n        \"updated_at\": \"<dateTime>\",\n        \"updated_stamp\": \"<string>\",\n        \"url\": \"<string>\",\n        \"via\": {\n          \"channel\": \"<string>\",\n          \"source\": {\n            \"ad_58d\": \"ex Duis est\"\n          }\n        },\n        \"via_followup_source_id\": \"<integer>\",\n        \"via_id\": \"<integer>\",\n        \"voice_comment\": {}\n      },\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"ticket\": {\n        \"requester_id\": \"<integer>\",\n        \"allow_attachments\": \"<boolean>\",\n        \"allow_channelback\": \"<boolean>\",\n        \"assignee_email\": \"<string>\",\n        \"assignee_id\": \"<integer>\",\n        \"attribute_value_ids\": \"<array>\",\n        \"brand_id\": \"<integer>\",\n        \"collaborator_ids\": \"<array>\",\n        \"collaborators\": [\n          {\n            \"email\": \"<email>\",\n            \"name\": \"<string>\"\n          },\n          {\n            \"email\": \"<email>\",\n            \"name\": \"<string>\"\n          }\n        ],\n        \"comment\": {},\n        \"created_at\": \"<dateTime>\",\n        \"custom_fields\": \"<array>\",\n        \"custom_status_id\": \"<integer>\",\n        \"description\": \"<string>\",\n        \"due_at\": \"<dateTime>\",\n        \"email_cc_ids\": \"<array>\",\n        \"email_ccs\": {},\n        \"external_id\": \"<string>\",\n        \"follower_ids\": \"<array>\",\n        \"followers\": {},\n        \"followup_ids\": \"<array>\",\n        \"forum_topic_id\": \"<integer>\",\n        \"from_messaging_channel\": \"<boolean>\",\n        \"group_id\": \"<integer>\",\n        \"has_incidents\": \"<boolean>\",\n        \"id\": \"<integer>\",\n        \"is_public\": \"<boolean>\",\n        \"macro_id\": \"<integer>\",\n        \"macro_ids\": \"<array>\",\n        \"metadata\": {},\n        \"organization_id\": \"<integer>\",\n        \"priority\": \"low\",\n        \"problem_id\": \"<integer>\",\n        \"raw_subject\": \"<string>\",\n        \"recipient\": \"<string>\",\n        \"requester\": {},\n        \"safe_update\": \"<boolean>\",\n        \"satisfaction_rating\": {\n          \"dolor3b\": true,\n          \"nonc7\": false\n        },\n        \"sharing_agreement_ids\": \"<array>\",\n        \"status\": \"solved\",\n        \"subject\": \"<string>\",\n        \"submitter_id\": \"<integer>\",\n        \"tags\": \"<array>\",\n        \"ticket_form_id\": \"<integer>\",\n        \"type\": \"task\",\n        \"updated_at\": \"<dateTime>\",\n        \"updated_stamp\": \"<string>\",\n        \"url\": \"<string>\",\n        \"via\": {\n          \"channel\": \"<string>\",\n          \"source\": {\n            \"exercitation_19\": \"incididunt tempor minim\",\n            \"proident_0\": \"proident qui ullamco\"\n          }\n        },\n        \"via_followup_source_id\": \"<integer>\",\n        \"via_id\": \"<integer>\",\n        \"voice_comment\": {}\n      },\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}