Chilkat Online Tools

.NET Core C# / Support API / Getting Comments

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

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

string content_type;
string content_url;
string deleted;
string file_name;
string height;
string id;
string inline;
string malware_access_override;
string malware_scan_result;
string mapped_content_url;
string size;
string url;
string width;
int j;
int count_j;
string strVal;

string Audit_id = jResp.StringOf("comment.audit_id");
string Author_id = jResp.StringOf("comment.author_id");
string Body = jResp.StringOf("comment.body");
string Created_at = jResp.StringOf("comment.created_at");
string Html_body = jResp.StringOf("comment.html_body");
string Id = jResp.StringOf("comment.id");
string Aliquipf9_ = jResp.StringOf("comment.metadata.aliquipf9_");
string Plain_body = jResp.StringOf("comment.plain_body");
string v_Public = jResp.StringOf("comment.public");
string v_Type = jResp.StringOf("comment.type");
string 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.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.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.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}"
    }
  ]
}