Chilkat Online Tools

delphiDll / Support API / Getting Comments

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
content_type: PWideChar;
content_url: PWideChar;
deleted: PWideChar;
file_name: PWideChar;
height: PWideChar;
id: PWideChar;
inline: PWideChar;
malware_access_override: PWideChar;
malware_scan_result: PWideChar;
mapped_content_url: PWideChar;
size: PWideChar;
url: PWideChar;
width: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
Audit_id: PWideChar;
Author_id: PWideChar;
Body: PWideChar;
Created_at: PWideChar;
Html_body: PWideChar;
Id: PWideChar;
Aliquipf9_: PWideChar;
Plain_body: PWideChar;
v_Public: PWideChar;
v_Type: PWideChar;
Channel: PWideChar;
Mollit8: Integer;
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 := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/requests/:request_id/comments/:ticket_comment_id',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

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

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

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

Audit_id := CkJsonObject__stringOf(jResp,'comment.audit_id');
Author_id := CkJsonObject__stringOf(jResp,'comment.author_id');
Body := CkJsonObject__stringOf(jResp,'comment.body');
Created_at := CkJsonObject__stringOf(jResp,'comment.created_at');
Html_body := CkJsonObject__stringOf(jResp,'comment.html_body');
Id := CkJsonObject__stringOf(jResp,'comment.id');
Aliquipf9_ := CkJsonObject__stringOf(jResp,'comment.metadata.aliquipf9_');
Plain_body := CkJsonObject__stringOf(jResp,'comment.plain_body');
v_Public := CkJsonObject__stringOf(jResp,'comment.public');
v_Type := CkJsonObject__stringOf(jResp,'comment.type');
Channel := CkJsonObject__stringOf(jResp,'comment.via.channel');
Mollit8 := CkJsonObject_IntOf(jResp,'comment.via.source.mollit8');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'comment.attachments');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    content_type := CkJsonObject__stringOf(jResp,'comment.attachments[i].content_type');
    content_url := CkJsonObject__stringOf(jResp,'comment.attachments[i].content_url');
    deleted := CkJsonObject__stringOf(jResp,'comment.attachments[i].deleted');
    file_name := CkJsonObject__stringOf(jResp,'comment.attachments[i].file_name');
    height := CkJsonObject__stringOf(jResp,'comment.attachments[i].height');
    id := CkJsonObject__stringOf(jResp,'comment.attachments[i].id');
    inline := CkJsonObject__stringOf(jResp,'comment.attachments[i].inline');
    malware_access_override := CkJsonObject__stringOf(jResp,'comment.attachments[i].malware_access_override');
    malware_scan_result := CkJsonObject__stringOf(jResp,'comment.attachments[i].malware_scan_result');
    mapped_content_url := CkJsonObject__stringOf(jResp,'comment.attachments[i].mapped_content_url');
    size := CkJsonObject__stringOf(jResp,'comment.attachments[i].size');
    url := CkJsonObject__stringOf(jResp,'comment.attachments[i].url');
    width := CkJsonObject__stringOf(jResp,'comment.attachments[i].width');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'comment.attachments[i].thumbnails');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        content_type := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].content_type');
        content_url := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].content_url');
        deleted := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].deleted');
        file_name := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].file_name');
        height := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].height');
        id := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].id');
        inline := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].inline');
        malware_access_override := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].malware_access_override');
        malware_scan_result := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].malware_scan_result');
        mapped_content_url := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].mapped_content_url');
        size := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].size');
        url := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].url');
        width := CkJsonObject__stringOf(jResp,'comment.attachments[i].thumbnails[j].width');
        j := j + 1;
      end;

    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'comment.uploads');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'comment.uploads[i]');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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