Chilkat Online Tools

C++ / Support API / Show Request

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

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

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

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/requests/:request_id",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

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

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "request": {
    //     "subject": "<string>",
    //     "assignee_id": "<integer>",
    //     "can_be_solved_by_me": "<boolean>",
    //     "collaborator_ids": [
    //       "<integer>",
    //       "<integer>"
    //     ],
    //     "created_at": "<dateTime>",
    //     "custom_fields": [
    //       {
    //         "id": "<integer>",
    //         "value": "<string>"
    //       },
    //       {
    //         "id": "<integer>",
    //         "value": "<string>"
    //       }
    //     ],
    //     "custom_status_id": "<integer>",
    //     "description": "<string>",
    //     "due_at": "<dateTime>",
    //     "email_cc_ids": [
    //       "<integer>",
    //       "<integer>"
    //     ],
    //     "followup_source_id": "<integer>",
    //     "group_id": "<integer>",
    //     "id": "<integer>",
    //     "is_public": "<boolean>",
    //     "organization_id": "<integer>",
    //     "priority": "<string>",
    //     "recipient": "<string>",
    //     "requester_id": "<integer>",
    //     "solved": "<boolean>",
    //     "status": "<string>",
    //     "ticket_form_id": "<integer>",
    //     "type": "<string>",
    //     "updated_at": "<dateTime>",
    //     "url": "<string>",
    //     "via": {
    //       "channel": "<string>",
    //       "source": {
    //         "est__": false
    //       }
    //     }
    //   }
    // }

    // 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 char *strVal = 0;
    const char *id = 0;
    const char *value = 0;

    const char *Subject = jResp.stringOf("request.subject");
    const char *Assignee_id = jResp.stringOf("request.assignee_id");
    const char *Can_be_solved_by_me = jResp.stringOf("request.can_be_solved_by_me");
    const char *Created_at = jResp.stringOf("request.created_at");
    const char *Custom_status_id = jResp.stringOf("request.custom_status_id");
    const char *Description = jResp.stringOf("request.description");
    const char *Due_at = jResp.stringOf("request.due_at");
    const char *Followup_source_id = jResp.stringOf("request.followup_source_id");
    const char *Group_id = jResp.stringOf("request.group_id");
    const char *Id = jResp.stringOf("request.id");
    const char *Is_public = jResp.stringOf("request.is_public");
    const char *Organization_id = jResp.stringOf("request.organization_id");
    const char *Priority = jResp.stringOf("request.priority");
    const char *Recipient = jResp.stringOf("request.recipient");
    const char *Requester_id = jResp.stringOf("request.requester_id");
    const char *Solved = jResp.stringOf("request.solved");
    const char *Status = jResp.stringOf("request.status");
    const char *Ticket_form_id = jResp.stringOf("request.ticket_form_id");
    const char *v_Type = jResp.stringOf("request.type");
    const char *Updated_at = jResp.stringOf("request.updated_at");
    const char *v_Url = jResp.stringOf("request.url");
    const char *Channel = jResp.stringOf("request.via.channel");
    bool Est__ = jResp.BoolOf("request.via.source.est__");
    int i = 0;
    int count_i = jResp.SizeOfArray("request.collaborator_ids");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("request.collaborator_ids[i]");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("request.custom_fields");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("request.custom_fields[i].id");
        value = jResp.stringOf("request.custom_fields[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("request.email_cc_ids");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("request.email_cc_ids[i]");
        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/:request_id

Postman Collection Item JSON

{
  "name": "Show Request",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests/:request_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests",
        ":request_id"
      ],
      "variable": [
        {
          "key": "request_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Sideloads\n\nThe following sideloads are supported:\n\n| Name             | Will sideload\n| ---------------- | -------------\n| users            | The email ccs for a request by side-loading users\n\n#### Allowed For\n\n* End Users\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/requests/:request_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests",
            ":request_id"
          ],
          "variable": [
            {
              "key": "request_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"request\": {\n    \"subject\": \"<string>\",\n    \"assignee_id\": \"<integer>\",\n    \"can_be_solved_by_me\": \"<boolean>\",\n    \"collaborator_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"custom_fields\": [\n      {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"custom_status_id\": \"<integer>\",\n    \"description\": \"<string>\",\n    \"due_at\": \"<dateTime>\",\n    \"email_cc_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"followup_source_id\": \"<integer>\",\n    \"group_id\": \"<integer>\",\n    \"id\": \"<integer>\",\n    \"is_public\": \"<boolean>\",\n    \"organization_id\": \"<integer>\",\n    \"priority\": \"<string>\",\n    \"recipient\": \"<string>\",\n    \"requester_id\": \"<integer>\",\n    \"solved\": \"<boolean>\",\n    \"status\": \"<string>\",\n    \"ticket_form_id\": \"<integer>\",\n    \"type\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"via\": {\n      \"channel\": \"<string>\",\n      \"source\": {\n        \"est__\": false\n      }\n    }\n  }\n}"
    }
  ]
}