Chilkat Online Tools

C# / 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.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

http.SetRequestHeader("Accept","application/json");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("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

string email;
string name;

string Requester_id = jResp.StringOf("ticket.requester_id");
string Allow_attachments = jResp.StringOf("ticket.allow_attachments");
string Allow_channelback = jResp.StringOf("ticket.allow_channelback");
string Assignee_email = jResp.StringOf("ticket.assignee_email");
string Assignee_id = jResp.StringOf("ticket.assignee_id");
string Attribute_value_ids = jResp.StringOf("ticket.attribute_value_ids");
string Brand_id = jResp.StringOf("ticket.brand_id");
string Collaborator_ids = jResp.StringOf("ticket.collaborator_ids");
string Created_at = jResp.StringOf("ticket.created_at");
string Custom_fields = jResp.StringOf("ticket.custom_fields");
string Custom_status_id = jResp.StringOf("ticket.custom_status_id");
string Description = jResp.StringOf("ticket.description");
string Due_at = jResp.StringOf("ticket.due_at");
string Email_cc_ids = jResp.StringOf("ticket.email_cc_ids");
string External_id = jResp.StringOf("ticket.external_id");
string Follower_ids = jResp.StringOf("ticket.follower_ids");
string Followup_ids = jResp.StringOf("ticket.followup_ids");
string Forum_topic_id = jResp.StringOf("ticket.forum_topic_id");
string From_messaging_channel = jResp.StringOf("ticket.from_messaging_channel");
string Group_id = jResp.StringOf("ticket.group_id");
string Has_incidents = jResp.StringOf("ticket.has_incidents");
string Id = jResp.StringOf("ticket.id");
string Is_public = jResp.StringOf("ticket.is_public");
string Macro_id = jResp.StringOf("ticket.macro_id");
string Macro_ids = jResp.StringOf("ticket.macro_ids");
string Organization_id = jResp.StringOf("ticket.organization_id");
string Priority = jResp.StringOf("ticket.priority");
string Problem_id = jResp.StringOf("ticket.problem_id");
string Raw_subject = jResp.StringOf("ticket.raw_subject");
string Recipient = jResp.StringOf("ticket.recipient");
string Safe_update = jResp.StringOf("ticket.safe_update");
string In_11 = jResp.StringOf("ticket.satisfaction_rating.in_11");
string Sharing_agreement_ids = jResp.StringOf("ticket.sharing_agreement_ids");
string Status = jResp.StringOf("ticket.status");
string Subject = jResp.StringOf("ticket.subject");
string Submitter_id = jResp.StringOf("ticket.submitter_id");
string Tags = jResp.StringOf("ticket.tags");
string Ticket_form_id = jResp.StringOf("ticket.ticket_form_id");
string v_Type = jResp.StringOf("ticket.type");
string Updated_at = jResp.StringOf("ticket.updated_at");
string Updated_stamp = jResp.StringOf("ticket.updated_stamp");
string v_Url = jResp.StringOf("ticket.url");
string Channel = jResp.StringOf("ticket.via.channel");
string Ut__a = jResp.StringOf("ticket.via.source.Ut__a");
int Dolored2b = jResp.IntOf("ticket.via.source.dolored2b");
bool Mollit1a6 = jResp.BoolOf("ticket.via.source.mollit1a6");
string Via_followup_source_id = jResp.StringOf("ticket.via_followup_source_id");
string Via_id = jResp.StringOf("ticket.via_id");
int i = 0;
int 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;
}

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