Foxpro / Support API / List Bookmarks
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCreated_at
LOCAL lcId
LOCAL lcRequester_id
LOCAL lcAllow_attachments
LOCAL lcAllow_channelback
LOCAL lcAssignee_email
LOCAL lcAssignee_id
LOCAL lcAttribute_value_ids
LOCAL lcBrand_id
LOCAL lcCollaborator_ids
LOCAL lcCreated_at
LOCAL lcCustom_fields
LOCAL lcCustom_status_id
LOCAL lcDescription
LOCAL lcDue_at
LOCAL lcEmail_cc_ids
LOCAL lcExternal_id
LOCAL lcFollower_ids
LOCAL lcFollowup_ids
LOCAL lcForum_topic_id
LOCAL lcFrom_messaging_channel
LOCAL lcGroup_id
LOCAL lcHas_incidents
LOCAL lcId
LOCAL lcIs_public
LOCAL lcMacro_id
LOCAL lcMacro_ids
LOCAL lcOrganization_id
LOCAL lcPriority
LOCAL lcProblem_id
LOCAL lcRaw_subject
LOCAL lcRecipient
LOCAL lcSafe_update
LOCAL lcQui_c2
LOCAL lcElit_74
LOCAL lcSharing_agreement_ids
LOCAL lcStatus
LOCAL lcSubject
LOCAL lcSubmitter_id
LOCAL lcTags
LOCAL lcTicket_form_id
LOCAL lcV_Type
LOCAL lcUpdated_at
LOCAL lcUpdated_stamp
LOCAL lcV_Url
LOCAL lcChannel
LOCAL lcAd_58d
LOCAL lcVia_followup_source_id
LOCAL lcVia_id
LOCAL lcUrl
LOCAL lnDolor3b
LOCAL lnNonc7
LOCAL lcExercitation_19
LOCAL lcProident_0
LOCAL j
LOCAL lnCount_j
LOCAL lcEmail
LOCAL lcName
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/bookmarks",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("bookmarks")
DO WHILE i < lnCount_i
loJResp.I = i
lcCreated_at = loJResp.StringOf("bookmarks[i].created_at")
lcId = loJResp.StringOf("bookmarks[i].id")
lcRequester_id = loJResp.StringOf("bookmarks[i].ticket.requester_id")
lcAllow_attachments = loJResp.StringOf("bookmarks[i].ticket.allow_attachments")
lcAllow_channelback = loJResp.StringOf("bookmarks[i].ticket.allow_channelback")
lcAssignee_email = loJResp.StringOf("bookmarks[i].ticket.assignee_email")
lcAssignee_id = loJResp.StringOf("bookmarks[i].ticket.assignee_id")
lcAttribute_value_ids = loJResp.StringOf("bookmarks[i].ticket.attribute_value_ids")
lcBrand_id = loJResp.StringOf("bookmarks[i].ticket.brand_id")
lcCollaborator_ids = loJResp.StringOf("bookmarks[i].ticket.collaborator_ids")
lcCreated_at = loJResp.StringOf("bookmarks[i].ticket.created_at")
lcCustom_fields = loJResp.StringOf("bookmarks[i].ticket.custom_fields")
lcCustom_status_id = loJResp.StringOf("bookmarks[i].ticket.custom_status_id")
lcDescription = loJResp.StringOf("bookmarks[i].ticket.description")
lcDue_at = loJResp.StringOf("bookmarks[i].ticket.due_at")
lcEmail_cc_ids = loJResp.StringOf("bookmarks[i].ticket.email_cc_ids")
lcExternal_id = loJResp.StringOf("bookmarks[i].ticket.external_id")
lcFollower_ids = loJResp.StringOf("bookmarks[i].ticket.follower_ids")
lcFollowup_ids = loJResp.StringOf("bookmarks[i].ticket.followup_ids")
lcForum_topic_id = loJResp.StringOf("bookmarks[i].ticket.forum_topic_id")
lcFrom_messaging_channel = loJResp.StringOf("bookmarks[i].ticket.from_messaging_channel")
lcGroup_id = loJResp.StringOf("bookmarks[i].ticket.group_id")
lcHas_incidents = loJResp.StringOf("bookmarks[i].ticket.has_incidents")
lcId = loJResp.StringOf("bookmarks[i].ticket.id")
lcIs_public = loJResp.StringOf("bookmarks[i].ticket.is_public")
lcMacro_id = loJResp.StringOf("bookmarks[i].ticket.macro_id")
lcMacro_ids = loJResp.StringOf("bookmarks[i].ticket.macro_ids")
lcOrganization_id = loJResp.StringOf("bookmarks[i].ticket.organization_id")
lcPriority = loJResp.StringOf("bookmarks[i].ticket.priority")
lcProblem_id = loJResp.StringOf("bookmarks[i].ticket.problem_id")
lcRaw_subject = loJResp.StringOf("bookmarks[i].ticket.raw_subject")
lcRecipient = loJResp.StringOf("bookmarks[i].ticket.recipient")
lcSafe_update = loJResp.StringOf("bookmarks[i].ticket.safe_update")
lcQui_c2 = loJResp.StringOf("bookmarks[i].ticket.satisfaction_rating.qui_c2")
lcElit_74 = loJResp.StringOf("bookmarks[i].ticket.satisfaction_rating.elit_74")
lcSharing_agreement_ids = loJResp.StringOf("bookmarks[i].ticket.sharing_agreement_ids")
lcStatus = loJResp.StringOf("bookmarks[i].ticket.status")
lcSubject = loJResp.StringOf("bookmarks[i].ticket.subject")
lcSubmitter_id = loJResp.StringOf("bookmarks[i].ticket.submitter_id")
lcTags = loJResp.StringOf("bookmarks[i].ticket.tags")
lcTicket_form_id = loJResp.StringOf("bookmarks[i].ticket.ticket_form_id")
lcV_Type = loJResp.StringOf("bookmarks[i].ticket.type")
lcUpdated_at = loJResp.StringOf("bookmarks[i].ticket.updated_at")
lcUpdated_stamp = loJResp.StringOf("bookmarks[i].ticket.updated_stamp")
lcV_Url = loJResp.StringOf("bookmarks[i].ticket.url")
lcChannel = loJResp.StringOf("bookmarks[i].ticket.via.channel")
lcAd_58d = loJResp.StringOf("bookmarks[i].ticket.via.source.ad_58d")
lcVia_followup_source_id = loJResp.StringOf("bookmarks[i].ticket.via_followup_source_id")
lcVia_id = loJResp.StringOf("bookmarks[i].ticket.via_id")
lcUrl = loJResp.StringOf("bookmarks[i].url")
lnDolor3b = loJResp.BoolOf("bookmarks[i].ticket.satisfaction_rating.dolor3b")
lnNonc7 = loJResp.BoolOf("bookmarks[i].ticket.satisfaction_rating.nonc7")
lcExercitation_19 = loJResp.StringOf("bookmarks[i].ticket.via.source.exercitation_19")
lcProident_0 = loJResp.StringOf("bookmarks[i].ticket.via.source.proident_0")
j = 0
lnCount_j = loJResp.SizeOfArray("bookmarks[i].ticket.collaborators")
DO WHILE j < lnCount_j
loJResp.J = j
lcEmail = loJResp.StringOf("bookmarks[i].ticket.collaborators[j].email")
lcName = loJResp.StringOf("bookmarks[i].ticket.collaborators[j].name")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
