PureBasic / Support API / Show Ticket
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/tickets/:ticket_id",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)
; {
; "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": {
; "in_11": -9796534.714120895
; },
; "sharing_agreement_ids": "<array>",
; "status": "hold",
; "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": {
; "Ut__a": -44750185.46031158,
; "dolored2b": 8252599,
; "mollit1a6": true
; }
; },
; "via_followup_source_id": "<integer>",
; "via_id": "<integer>",
; "voice_comment": {}
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
email.s
name.s
Requester_id.s = CkJsonObject::ckStringOf(jResp,"ticket.requester_id")
Allow_attachments.s = CkJsonObject::ckStringOf(jResp,"ticket.allow_attachments")
Allow_channelback.s = CkJsonObject::ckStringOf(jResp,"ticket.allow_channelback")
Assignee_email.s = CkJsonObject::ckStringOf(jResp,"ticket.assignee_email")
Assignee_id.s = CkJsonObject::ckStringOf(jResp,"ticket.assignee_id")
Attribute_value_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.attribute_value_ids")
Brand_id.s = CkJsonObject::ckStringOf(jResp,"ticket.brand_id")
Collaborator_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.collaborator_ids")
Created_at.s = CkJsonObject::ckStringOf(jResp,"ticket.created_at")
Custom_fields.s = CkJsonObject::ckStringOf(jResp,"ticket.custom_fields")
Custom_status_id.s = CkJsonObject::ckStringOf(jResp,"ticket.custom_status_id")
Description.s = CkJsonObject::ckStringOf(jResp,"ticket.description")
Due_at.s = CkJsonObject::ckStringOf(jResp,"ticket.due_at")
Email_cc_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.email_cc_ids")
External_id.s = CkJsonObject::ckStringOf(jResp,"ticket.external_id")
Follower_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.follower_ids")
Followup_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.followup_ids")
Forum_topic_id.s = CkJsonObject::ckStringOf(jResp,"ticket.forum_topic_id")
From_messaging_channel.s = CkJsonObject::ckStringOf(jResp,"ticket.from_messaging_channel")
Group_id.s = CkJsonObject::ckStringOf(jResp,"ticket.group_id")
Has_incidents.s = CkJsonObject::ckStringOf(jResp,"ticket.has_incidents")
Id.s = CkJsonObject::ckStringOf(jResp,"ticket.id")
Is_public.s = CkJsonObject::ckStringOf(jResp,"ticket.is_public")
Macro_id.s = CkJsonObject::ckStringOf(jResp,"ticket.macro_id")
Macro_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.macro_ids")
Organization_id.s = CkJsonObject::ckStringOf(jResp,"ticket.organization_id")
Priority.s = CkJsonObject::ckStringOf(jResp,"ticket.priority")
Problem_id.s = CkJsonObject::ckStringOf(jResp,"ticket.problem_id")
Raw_subject.s = CkJsonObject::ckStringOf(jResp,"ticket.raw_subject")
Recipient.s = CkJsonObject::ckStringOf(jResp,"ticket.recipient")
Safe_update.s = CkJsonObject::ckStringOf(jResp,"ticket.safe_update")
In_11.s = CkJsonObject::ckStringOf(jResp,"ticket.satisfaction_rating.in_11")
Sharing_agreement_ids.s = CkJsonObject::ckStringOf(jResp,"ticket.sharing_agreement_ids")
Status.s = CkJsonObject::ckStringOf(jResp,"ticket.status")
Subject.s = CkJsonObject::ckStringOf(jResp,"ticket.subject")
Submitter_id.s = CkJsonObject::ckStringOf(jResp,"ticket.submitter_id")
Tags.s = CkJsonObject::ckStringOf(jResp,"ticket.tags")
Ticket_form_id.s = CkJsonObject::ckStringOf(jResp,"ticket.ticket_form_id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"ticket.type")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"ticket.updated_at")
Updated_stamp.s = CkJsonObject::ckStringOf(jResp,"ticket.updated_stamp")
v_Url.s = CkJsonObject::ckStringOf(jResp,"ticket.url")
Channel.s = CkJsonObject::ckStringOf(jResp,"ticket.via.channel")
Ut__a.s = CkJsonObject::ckStringOf(jResp,"ticket.via.source.Ut__a")
Dolored2b.i = CkJsonObject::ckIntOf(jResp,"ticket.via.source.dolored2b")
Mollit1a6.i = CkJsonObject::ckBoolOf(jResp,"ticket.via.source.mollit1a6")
Via_followup_source_id.s = CkJsonObject::ckStringOf(jResp,"ticket.via_followup_source_id")
Via_id.s = CkJsonObject::ckStringOf(jResp,"ticket.via_id")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ticket.collaborators")
While i < count_i
CkJsonObject::setCkI(jResp, i)
email = CkJsonObject::ckStringOf(jResp,"ticket.collaborators[i].email")
name = CkJsonObject::ckStringOf(jResp,"ticket.collaborators[i].name")
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/tickets/:ticket_id
Postman Collection Item JSON
{
"name": "Show Ticket",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Returns a number of ticket properties though not the ticket comments. To get the comments, use [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments)\n\n#### Allowed For\n* Agents"
},
"response": [
{
"name": "Ticket",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\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 \"in_11\": -9796534.714120895\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"hold\",\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 \"Ut__a\": -44750185.46031158,\n \"dolored2b\": 8252599,\n \"mollit1a6\": true\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n}"
}
]
}
