Chilkat Online Tools

C++ / Support API / Getting Comments

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/comments/:ticket_comment_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)

    // {
    //   "comment": {
    //     "attachments": [
    //       {
    //         "content_type": "<string>",
    //         "content_url": "<string>",
    //         "deleted": "<boolean>",
    //         "file_name": "<string>",
    //         "height": "<string>",
    //         "id": "<integer>",
    //         "inline": "<boolean>",
    //         "malware_access_override": "<boolean>",
    //         "malware_scan_result": "<string>",
    //         "mapped_content_url": "<string>",
    //         "size": "<integer>",
    //         "url": "<string>",
    //         "width": "<string>",
    //         "thumbnails": [
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           },
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           }
    //         ]
    //       },
    //       {
    //         "content_type": "<string>",
    //         "content_url": "<string>",
    //         "deleted": "<boolean>",
    //         "file_name": "<string>",
    //         "height": "<string>",
    //         "id": "<integer>",
    //         "inline": "<boolean>",
    //         "malware_access_override": "<boolean>",
    //         "malware_scan_result": "<string>",
    //         "mapped_content_url": "<string>",
    //         "size": "<integer>",
    //         "url": "<string>",
    //         "width": "<string>",
    //         "thumbnails": [
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           },
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           }
    //         ]
    //       }
    //     ],
    //     "audit_id": "<integer>",
    //     "author_id": "<integer>",
    //     "body": "<string>",
    //     "created_at": "<dateTime>",
    //     "html_body": "<string>",
    //     "id": "<integer>",
    //     "metadata": {
    //       "aliquipf9_": 29396975.17451787
    //     },
    //     "plain_body": "<string>",
    //     "public": "<boolean>",
    //     "type": "<string>",
    //     "uploads": [
    //       "<string>",
    //       "<string>"
    //     ],
    //     "via": {
    //       "channel": "<string>",
    //       "source": {
    //         "mollit8": -84219258
    //       }
    //     }
    //   }
    // }

    // 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 *content_type = 0;
    const char *content_url = 0;
    const char *deleted = 0;
    const char *file_name = 0;
    const char *height = 0;
    const char *id = 0;
    const char *inline = 0;
    const char *malware_access_override = 0;
    const char *malware_scan_result = 0;
    const char *mapped_content_url = 0;
    const char *size = 0;
    const char *url = 0;
    const char *width = 0;
    int j;
    int count_j;
    const char *strVal = 0;

    const char *Audit_id = jResp.stringOf("comment.audit_id");
    const char *Author_id = jResp.stringOf("comment.author_id");
    const char *Body = jResp.stringOf("comment.body");
    const char *Created_at = jResp.stringOf("comment.created_at");
    const char *Html_body = jResp.stringOf("comment.html_body");
    const char *Id = jResp.stringOf("comment.id");
    const char *Aliquipf9_ = jResp.stringOf("comment.metadata.aliquipf9_");
    const char *Plain_body = jResp.stringOf("comment.plain_body");
    const char *v_Public = jResp.stringOf("comment.public");
    const char *v_Type = jResp.stringOf("comment.type");
    const char *Channel = jResp.stringOf("comment.via.channel");
    int Mollit8 = jResp.IntOf("comment.via.source.mollit8");
    int i = 0;
    int count_i = jResp.SizeOfArray("comment.attachments");
    while (i < count_i) {
        jResp.put_I(i);
        content_type = jResp.stringOf("comment.attachments[i].content_type");
        content_url = jResp.stringOf("comment.attachments[i].content_url");
        deleted = jResp.stringOf("comment.attachments[i].deleted");
        file_name = jResp.stringOf("comment.attachments[i].file_name");
        height = jResp.stringOf("comment.attachments[i].height");
        id = jResp.stringOf("comment.attachments[i].id");
        inline = jResp.stringOf("comment.attachments[i].inline");
        malware_access_override = jResp.stringOf("comment.attachments[i].malware_access_override");
        malware_scan_result = jResp.stringOf("comment.attachments[i].malware_scan_result");
        mapped_content_url = jResp.stringOf("comment.attachments[i].mapped_content_url");
        size = jResp.stringOf("comment.attachments[i].size");
        url = jResp.stringOf("comment.attachments[i].url");
        width = jResp.stringOf("comment.attachments[i].width");
        j = 0;
        count_j = jResp.SizeOfArray("comment.attachments[i].thumbnails");
        while (j < count_j) {
            jResp.put_J(j);
            content_type = jResp.stringOf("comment.attachments[i].thumbnails[j].content_type");
            content_url = jResp.stringOf("comment.attachments[i].thumbnails[j].content_url");
            deleted = jResp.stringOf("comment.attachments[i].thumbnails[j].deleted");
            file_name = jResp.stringOf("comment.attachments[i].thumbnails[j].file_name");
            height = jResp.stringOf("comment.attachments[i].thumbnails[j].height");
            id = jResp.stringOf("comment.attachments[i].thumbnails[j].id");
            inline = jResp.stringOf("comment.attachments[i].thumbnails[j].inline");
            malware_access_override = jResp.stringOf("comment.attachments[i].thumbnails[j].malware_access_override");
            malware_scan_result = jResp.stringOf("comment.attachments[i].thumbnails[j].malware_scan_result");
            mapped_content_url = jResp.stringOf("comment.attachments[i].thumbnails[j].mapped_content_url");
            size = jResp.stringOf("comment.attachments[i].thumbnails[j].size");
            url = jResp.stringOf("comment.attachments[i].thumbnails[j].url");
            width = jResp.stringOf("comment.attachments[i].thumbnails[j].width");
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("comment.uploads");
    while (i < count_i) {
        jResp.put_I(i);
        strVal = jResp.stringOf("comment.uploads[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/comments/:ticket_comment_id

Postman Collection Item JSON

{
  "name": "Getting Comments",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests/:request_id/comments/:ticket_comment_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests",
        ":request_id",
        "comments",
        ":ticket_comment_id"
      ],
      "variable": [
        {
          "key": "request_id",
          "value": "<integer>"
        },
        {
          "key": "ticket_comment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/comments/:ticket_comment_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests",
            ":request_id",
            "comments",
            ":ticket_comment_id"
          ],
          "variable": [
            {
              "key": "request_id"
            },
            {
              "key": "ticket_comment_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"comment\": {\n    \"attachments\": [\n      {\n        \"content_type\": \"<string>\",\n        \"content_url\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"file_name\": \"<string>\",\n        \"height\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"inline\": \"<boolean>\",\n        \"malware_access_override\": \"<boolean>\",\n        \"malware_scan_result\": \"<string>\",\n        \"mapped_content_url\": \"<string>\",\n        \"size\": \"<integer>\",\n        \"url\": \"<string>\",\n        \"width\": \"<string>\",\n        \"thumbnails\": [\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          },\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          }\n        ]\n      },\n      {\n        \"content_type\": \"<string>\",\n        \"content_url\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"file_name\": \"<string>\",\n        \"height\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"inline\": \"<boolean>\",\n        \"malware_access_override\": \"<boolean>\",\n        \"malware_scan_result\": \"<string>\",\n        \"mapped_content_url\": \"<string>\",\n        \"size\": \"<integer>\",\n        \"url\": \"<string>\",\n        \"width\": \"<string>\",\n        \"thumbnails\": [\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          },\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          }\n        ]\n      }\n    ],\n    \"audit_id\": \"<integer>\",\n    \"author_id\": \"<integer>\",\n    \"body\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"html_body\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"metadata\": {\n      \"aliquipf9_\": 29396975.17451787\n    },\n    \"plain_body\": \"<string>\",\n    \"public\": \"<boolean>\",\n    \"type\": \"<string>\",\n    \"uploads\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"via\": {\n      \"channel\": \"<string>\",\n      \"source\": {\n        \"mollit8\": -84219258\n      }\n    }\n  }\n}"
    }
  ]
}