Chilkat Online Tools

unicodeCpp / Support API / Show Ticket

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

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

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

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

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/tickets/:ticket_id",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *email = 0;
    const wchar_t *name = 0;

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