Chilkat Online Tools

Xojo / Support API / Show Ticket

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// 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

Dim email As String
Dim name As String

Dim Requester_id As String
Requester_id = jResp.StringOf("ticket.requester_id")
Dim Allow_attachments As String
Allow_attachments = jResp.StringOf("ticket.allow_attachments")
Dim Allow_channelback As String
Allow_channelback = jResp.StringOf("ticket.allow_channelback")
Dim Assignee_email As String
Assignee_email = jResp.StringOf("ticket.assignee_email")
Dim Assignee_id As String
Assignee_id = jResp.StringOf("ticket.assignee_id")
Dim Attribute_value_ids As String
Attribute_value_ids = jResp.StringOf("ticket.attribute_value_ids")
Dim Brand_id As String
Brand_id = jResp.StringOf("ticket.brand_id")
Dim Collaborator_ids As String
Collaborator_ids = jResp.StringOf("ticket.collaborator_ids")
Dim Created_at As String
Created_at = jResp.StringOf("ticket.created_at")
Dim Custom_fields As String
Custom_fields = jResp.StringOf("ticket.custom_fields")
Dim Custom_status_id As String
Custom_status_id = jResp.StringOf("ticket.custom_status_id")
Dim Description As String
Description = jResp.StringOf("ticket.description")
Dim Due_at As String
Due_at = jResp.StringOf("ticket.due_at")
Dim Email_cc_ids As String
Email_cc_ids = jResp.StringOf("ticket.email_cc_ids")
Dim External_id As String
External_id = jResp.StringOf("ticket.external_id")
Dim Follower_ids As String
Follower_ids = jResp.StringOf("ticket.follower_ids")
Dim Followup_ids As String
Followup_ids = jResp.StringOf("ticket.followup_ids")
Dim Forum_topic_id As String
Forum_topic_id = jResp.StringOf("ticket.forum_topic_id")
Dim From_messaging_channel As String
From_messaging_channel = jResp.StringOf("ticket.from_messaging_channel")
Dim Group_id As String
Group_id = jResp.StringOf("ticket.group_id")
Dim Has_incidents As String
Has_incidents = jResp.StringOf("ticket.has_incidents")
Dim Id As String
Id = jResp.StringOf("ticket.id")
Dim Is_public As String
Is_public = jResp.StringOf("ticket.is_public")
Dim Macro_id As String
Macro_id = jResp.StringOf("ticket.macro_id")
Dim Macro_ids As String
Macro_ids = jResp.StringOf("ticket.macro_ids")
Dim Organization_id As String
Organization_id = jResp.StringOf("ticket.organization_id")
Dim Priority As String
Priority = jResp.StringOf("ticket.priority")
Dim Problem_id As String
Problem_id = jResp.StringOf("ticket.problem_id")
Dim Raw_subject As String
Raw_subject = jResp.StringOf("ticket.raw_subject")
Dim Recipient As String
Recipient = jResp.StringOf("ticket.recipient")
Dim Safe_update As String
Safe_update = jResp.StringOf("ticket.safe_update")
Dim In_11 As String
In_11 = jResp.StringOf("ticket.satisfaction_rating.in_11")
Dim Sharing_agreement_ids As String
Sharing_agreement_ids = jResp.StringOf("ticket.sharing_agreement_ids")
Dim Status As String
Status = jResp.StringOf("ticket.status")
Dim Subject As String
Subject = jResp.StringOf("ticket.subject")
Dim Submitter_id As String
Submitter_id = jResp.StringOf("ticket.submitter_id")
Dim Tags As String
Tags = jResp.StringOf("ticket.tags")
Dim Ticket_form_id As String
Ticket_form_id = jResp.StringOf("ticket.ticket_form_id")
Dim v_Type As String
v_Type = jResp.StringOf("ticket.type")
Dim Updated_at As String
Updated_at = jResp.StringOf("ticket.updated_at")
Dim Updated_stamp As String
Updated_stamp = jResp.StringOf("ticket.updated_stamp")
Dim v_Url As String
v_Url = jResp.StringOf("ticket.url")
Dim Channel As String
Channel = jResp.StringOf("ticket.via.channel")
Dim Ut__a As String
Ut__a = jResp.StringOf("ticket.via.source.Ut__a")
Dim Dolored2b As Int32
Dolored2b = jResp.IntOf("ticket.via.source.dolored2b")
Dim Mollit1a6 As Boolean
Mollit1a6 = jResp.BoolOf("ticket.via.source.mollit1a6")
Dim Via_followup_source_id As String
Via_followup_source_id = jResp.StringOf("ticket.via_followup_source_id")
Dim Via_id As String
Via_id = jResp.StringOf("ticket.via_id")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("ticket.collaborators")
While i < count_i
    jResp.I = i
    email = jResp.StringOf("ticket.collaborators[i].email")
    name = jResp.StringOf("ticket.collaborators[i].name")
    i = i + 1
Wend

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}"
    }
  ]
}