delphiDll / Support API / List Bookmarks
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
created_at: PWideChar;
id: PWideChar;
Requester_id: PWideChar;
Allow_attachments: PWideChar;
Allow_channelback: PWideChar;
Assignee_email: PWideChar;
Assignee_id: PWideChar;
Attribute_value_ids: PWideChar;
Brand_id: PWideChar;
Collaborator_ids: PWideChar;
Created_at: PWideChar;
Custom_fields: PWideChar;
Custom_status_id: PWideChar;
Description: PWideChar;
Due_at: PWideChar;
Email_cc_ids: PWideChar;
External_id: PWideChar;
Follower_ids: PWideChar;
Followup_ids: PWideChar;
Forum_topic_id: PWideChar;
From_messaging_channel: PWideChar;
Group_id: PWideChar;
Has_incidents: PWideChar;
Id: PWideChar;
Is_public: PWideChar;
Macro_id: PWideChar;
Macro_ids: PWideChar;
Organization_id: PWideChar;
Priority: PWideChar;
Problem_id: PWideChar;
Raw_subject: PWideChar;
Recipient: PWideChar;
Safe_update: PWideChar;
Qui_c2: PWideChar;
Elit_74: PWideChar;
Sharing_agreement_ids: PWideChar;
Status: PWideChar;
Subject: PWideChar;
Submitter_id: PWideChar;
Tags: PWideChar;
Ticket_form_id: PWideChar;
v_Type: PWideChar;
Updated_at: PWideChar;
Updated_stamp: PWideChar;
v_Url: PWideChar;
Channel: PWideChar;
Ad_58d: PWideChar;
Via_followup_source_id: PWideChar;
Via_id: PWideChar;
url: PWideChar;
Dolor3b: Boolean;
Nonc7: Boolean;
Exercitation_19: PWideChar;
Proident_0: PWideChar;
j: Integer;
count_j: Integer;
email: PWideChar;
name: PWideChar;
count: PWideChar;
next_page: PWideChar;
previous_page: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/bookmarks',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
count := CkJsonObject__stringOf(jResp,'count');
next_page := CkJsonObject__stringOf(jResp,'next_page');
previous_page := CkJsonObject__stringOf(jResp,'previous_page');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'bookmarks');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
created_at := CkJsonObject__stringOf(jResp,'bookmarks[i].created_at');
id := CkJsonObject__stringOf(jResp,'bookmarks[i].id');
Requester_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.requester_id');
Allow_attachments := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.allow_attachments');
Allow_channelback := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.allow_channelback');
Assignee_email := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.assignee_email');
Assignee_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.assignee_id');
Attribute_value_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.attribute_value_ids');
Brand_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.brand_id');
Collaborator_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.collaborator_ids');
Created_at := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.created_at');
Custom_fields := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.custom_fields');
Custom_status_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.custom_status_id');
Description := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.description');
Due_at := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.due_at');
Email_cc_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.email_cc_ids');
External_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.external_id');
Follower_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.follower_ids');
Followup_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.followup_ids');
Forum_topic_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.forum_topic_id');
From_messaging_channel := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.from_messaging_channel');
Group_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.group_id');
Has_incidents := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.has_incidents');
Id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.id');
Is_public := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.is_public');
Macro_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.macro_id');
Macro_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.macro_ids');
Organization_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.organization_id');
Priority := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.priority');
Problem_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.problem_id');
Raw_subject := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.raw_subject');
Recipient := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.recipient');
Safe_update := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.safe_update');
Qui_c2 := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.satisfaction_rating.qui_c2');
Elit_74 := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.satisfaction_rating.elit_74');
Sharing_agreement_ids := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.sharing_agreement_ids');
Status := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.status');
Subject := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.subject');
Submitter_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.submitter_id');
Tags := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.tags');
Ticket_form_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.ticket_form_id');
v_Type := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.type');
Updated_at := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.updated_at');
Updated_stamp := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.updated_stamp');
v_Url := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.url');
Channel := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.via.channel');
Ad_58d := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.via.source.ad_58d');
Via_followup_source_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.via_followup_source_id');
Via_id := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.via_id');
url := CkJsonObject__stringOf(jResp,'bookmarks[i].url');
Dolor3b := CkJsonObject_BoolOf(jResp,'bookmarks[i].ticket.satisfaction_rating.dolor3b');
Nonc7 := CkJsonObject_BoolOf(jResp,'bookmarks[i].ticket.satisfaction_rating.nonc7');
Exercitation_19 := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.via.source.exercitation_19');
Proident_0 := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.via.source.proident_0');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'bookmarks[i].ticket.collaborators');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
email := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.collaborators[j].email');
name := CkJsonObject__stringOf(jResp,'bookmarks[i].ticket.collaborators[j].name');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
