Chilkat Online Tools

Xojo / Support API / List Bookmarks

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"

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/bookmarks",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

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 = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

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

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

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