Swift3 / Support API / Show Ticket
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
http.setRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("Failed.")
return
}
// 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
var email: String?
var name: String?
var Requester_id: String? = jResp.string(of: "ticket.requester_id")
var Allow_attachments: String? = jResp.string(of: "ticket.allow_attachments")
var Allow_channelback: String? = jResp.string(of: "ticket.allow_channelback")
var Assignee_email: String? = jResp.string(of: "ticket.assignee_email")
var Assignee_id: String? = jResp.string(of: "ticket.assignee_id")
var Attribute_value_ids: String? = jResp.string(of: "ticket.attribute_value_ids")
var Brand_id: String? = jResp.string(of: "ticket.brand_id")
var Collaborator_ids: String? = jResp.string(of: "ticket.collaborator_ids")
var Created_at: String? = jResp.string(of: "ticket.created_at")
var Custom_fields: String? = jResp.string(of: "ticket.custom_fields")
var Custom_status_id: String? = jResp.string(of: "ticket.custom_status_id")
var Description: String? = jResp.string(of: "ticket.description")
var Due_at: String? = jResp.string(of: "ticket.due_at")
var Email_cc_ids: String? = jResp.string(of: "ticket.email_cc_ids")
var External_id: String? = jResp.string(of: "ticket.external_id")
var Follower_ids: String? = jResp.string(of: "ticket.follower_ids")
var Followup_ids: String? = jResp.string(of: "ticket.followup_ids")
var Forum_topic_id: String? = jResp.string(of: "ticket.forum_topic_id")
var From_messaging_channel: String? = jResp.string(of: "ticket.from_messaging_channel")
var Group_id: String? = jResp.string(of: "ticket.group_id")
var Has_incidents: String? = jResp.string(of: "ticket.has_incidents")
var Id: String? = jResp.string(of: "ticket.id")
var Is_public: String? = jResp.string(of: "ticket.is_public")
var Macro_id: String? = jResp.string(of: "ticket.macro_id")
var Macro_ids: String? = jResp.string(of: "ticket.macro_ids")
var Organization_id: String? = jResp.string(of: "ticket.organization_id")
var Priority: String? = jResp.string(of: "ticket.priority")
var Problem_id: String? = jResp.string(of: "ticket.problem_id")
var Raw_subject: String? = jResp.string(of: "ticket.raw_subject")
var Recipient: String? = jResp.string(of: "ticket.recipient")
var Safe_update: String? = jResp.string(of: "ticket.safe_update")
var In_11: String? = jResp.string(of: "ticket.satisfaction_rating.in_11")
var Sharing_agreement_ids: String? = jResp.string(of: "ticket.sharing_agreement_ids")
var Status: String? = jResp.string(of: "ticket.status")
var Subject: String? = jResp.string(of: "ticket.subject")
var Submitter_id: String? = jResp.string(of: "ticket.submitter_id")
var Tags: String? = jResp.string(of: "ticket.tags")
var Ticket_form_id: String? = jResp.string(of: "ticket.ticket_form_id")
var v_Type: String? = jResp.string(of: "ticket.type")
var Updated_at: String? = jResp.string(of: "ticket.updated_at")
var Updated_stamp: String? = jResp.string(of: "ticket.updated_stamp")
var v_Url: String? = jResp.string(of: "ticket.url")
var Channel: String? = jResp.string(of: "ticket.via.channel")
var Ut__a: String? = jResp.string(of: "ticket.via.source.Ut__a")
var Dolored2b: Int = jResp.int(of: "ticket.via.source.dolored2b").intValue
var Mollit1a6: Bool = jResp.bool(of: "ticket.via.source.mollit1a6")
var Via_followup_source_id: String? = jResp.string(of: "ticket.via_followup_source_id")
var Via_id: String? = jResp.string(of: "ticket.via_id")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "ticket.collaborators").intValue
while i < count_i {
jResp.i = i
email = jResp.string(of: "ticket.collaborators[i].email")
name = jResp.string(of: "ticket.collaborators[i].name")
i = i + 1
}
}
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}"
}
]
}
