Chilkat Online Tools

delphiAx / Support API / Show Ticket

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
email: WideString;
name: WideString;
Requester_id: WideString;
Allow_attachments: WideString;
Allow_channelback: WideString;
Assignee_email: WideString;
Assignee_id: WideString;
Attribute_value_ids: WideString;
Brand_id: WideString;
Collaborator_ids: WideString;
Created_at: WideString;
Custom_fields: WideString;
Custom_status_id: WideString;
Description: WideString;
Due_at: WideString;
Email_cc_ids: WideString;
External_id: WideString;
Follower_ids: WideString;
Followup_ids: WideString;
Forum_topic_id: WideString;
From_messaging_channel: WideString;
Group_id: WideString;
Has_incidents: WideString;
Id: WideString;
Is_public: WideString;
Macro_id: WideString;
Macro_ids: WideString;
Organization_id: WideString;
Priority: WideString;
Problem_id: WideString;
Raw_subject: WideString;
Recipient: WideString;
Safe_update: WideString;
In_11: WideString;
Sharing_agreement_ids: WideString;
Status: WideString;
Subject: WideString;
Submitter_id: WideString;
Tags: WideString;
Ticket_form_id: WideString;
v_Type: WideString;
Updated_at: WideString;
Updated_stamp: WideString;
v_Url: WideString;
Channel: WideString;
Ut__a: WideString;
Dolored2b: Integer;
Mollit1a6: Integer;
Via_followup_source_id: WideString;
Via_id: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

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

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://example.zendesk.com/api/v2/tickets/:ticket_id',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

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

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