PureBasic / Support API / List Bookmarks
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/bookmarks",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
created_at.s
id.s
Requester_id.s
Allow_attachments.s
Allow_channelback.s
Assignee_email.s
Assignee_id.s
Attribute_value_ids.s
Brand_id.s
Collaborator_ids.s
Created_at.s
Custom_fields.s
Custom_status_id.s
Description.s
Due_at.s
Email_cc_ids.s
External_id.s
Follower_ids.s
Followup_ids.s
Forum_topic_id.s
From_messaging_channel.s
Group_id.s
Has_incidents.s
Id.s
Is_public.s
Macro_id.s
Macro_ids.s
Organization_id.s
Priority.s
Problem_id.s
Raw_subject.s
Recipient.s
Safe_update.s
Qui_c2.s
Elit_74.s
Sharing_agreement_ids.s
Status.s
Subject.s
Submitter_id.s
Tags.s
Ticket_form_id.s
v_Type.s
Updated_at.s
Updated_stamp.s
v_Url.s
Channel.s
Ad_58d.s
Via_followup_source_id.s
Via_id.s
url.s
Dolor3b.i
Nonc7.i
Exercitation_19.s
Proident_0.s
j.i
count_j.i
email.s
name.s
count.s = CkJsonObject::ckStringOf(jResp,"count")
next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"bookmarks")
While i < count_i
CkJsonObject::setCkI(jResp, i)
created_at = CkJsonObject::ckStringOf(jResp,"bookmarks[i].created_at")
id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].id")
Requester_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.requester_id")
Allow_attachments = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.allow_attachments")
Allow_channelback = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.allow_channelback")
Assignee_email = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.assignee_email")
Assignee_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.assignee_id")
Attribute_value_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.attribute_value_ids")
Brand_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.brand_id")
Collaborator_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.collaborator_ids")
Created_at = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.created_at")
Custom_fields = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.custom_fields")
Custom_status_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.custom_status_id")
Description = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.description")
Due_at = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.due_at")
Email_cc_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.email_cc_ids")
External_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.external_id")
Follower_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.follower_ids")
Followup_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.followup_ids")
Forum_topic_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.forum_topic_id")
From_messaging_channel = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.from_messaging_channel")
Group_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.group_id")
Has_incidents = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.has_incidents")
Id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.id")
Is_public = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.is_public")
Macro_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.macro_id")
Macro_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.macro_ids")
Organization_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.organization_id")
Priority = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.priority")
Problem_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.problem_id")
Raw_subject = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.raw_subject")
Recipient = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.recipient")
Safe_update = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.safe_update")
Qui_c2 = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.satisfaction_rating.qui_c2")
Elit_74 = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.satisfaction_rating.elit_74")
Sharing_agreement_ids = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.sharing_agreement_ids")
Status = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.status")
Subject = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.subject")
Submitter_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.submitter_id")
Tags = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.tags")
Ticket_form_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.ticket_form_id")
v_Type = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.type")
Updated_at = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.updated_at")
Updated_stamp = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.updated_stamp")
v_Url = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.url")
Channel = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.via.channel")
Ad_58d = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.via.source.ad_58d")
Via_followup_source_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.via_followup_source_id")
Via_id = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.via_id")
url = CkJsonObject::ckStringOf(jResp,"bookmarks[i].url")
Dolor3b = CkJsonObject::ckBoolOf(jResp,"bookmarks[i].ticket.satisfaction_rating.dolor3b")
Nonc7 = CkJsonObject::ckBoolOf(jResp,"bookmarks[i].ticket.satisfaction_rating.nonc7")
Exercitation_19 = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.via.source.exercitation_19")
Proident_0 = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.via.source.proident_0")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"bookmarks[i].ticket.collaborators")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
email = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.collaborators[j].email")
name = CkJsonObject::ckStringOf(jResp,"bookmarks[i].ticket.collaborators[j].name")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
