Chilkat Tools

delphiDll / Support API / Show Attachment

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;
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;
v_Url: PWideChar;
Width: PWideChar;
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/attachments/:attachment_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)

// {
//   "attachment": {
//     "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>"
//       }
//     ]
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Content_type := CkJsonObject__stringOf(jResp,'attachment.content_type');
Content_url := CkJsonObject__stringOf(jResp,'attachment.content_url');
Deleted := CkJsonObject__stringOf(jResp,'attachment.deleted');
File_name := CkJsonObject__stringOf(jResp,'attachment.file_name');
Height := CkJsonObject__stringOf(jResp,'attachment.height');
Id := CkJsonObject__stringOf(jResp,'attachment.id');
Inline := CkJsonObject__stringOf(jResp,'attachment.inline');
Malware_access_override := CkJsonObject__stringOf(jResp,'attachment.malware_access_override');
Malware_scan_result := CkJsonObject__stringOf(jResp,'attachment.malware_scan_result');
Mapped_content_url := CkJsonObject__stringOf(jResp,'attachment.mapped_content_url');
Size := CkJsonObject__stringOf(jResp,'attachment.size');
v_Url := CkJsonObject__stringOf(jResp,'attachment.url');
Width := CkJsonObject__stringOf(jResp,'attachment.width');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'attachment.thumbnails');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    content_type := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].content_type');
    content_url := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].content_url');
    deleted := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].deleted');
    file_name := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].file_name');
    height := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].height');
    id := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].id');
    inline := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].inline');
    malware_access_override := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].malware_access_override');
    malware_scan_result := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].malware_scan_result');
    mapped_content_url := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].mapped_content_url');
    size := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].size');
    url := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].url');
    width := CkJsonObject__stringOf(jResp,'attachment.thumbnails[i].width');
    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/attachments/:attachment_id

Postman Collection Item JSON

{
  "name": "Show Attachment",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/attachments/:attachment_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "attachments",
        ":attachment_id"
      ],
      "variable": [
        {
          "key": "attachment_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Shows attachment details. You can get the value of the `attachment_id` parameter by listing the ticket's comments.\nSee [List Comments](/api-reference/ticketing/tickets/ticket_comments/#list-comments). Each comment\nin the list has an `attachments` list that specifies an `id` for each attachment.\n\n\n #### Allowed for\n\n * Agents\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/attachments/:attachment_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "attachments",
            ":attachment_id"
          ],
          "variable": [
            {
              "key": "attachment_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attachment\": {\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}"
    }
  ]
}

Chilkat Online Tools

delphiDll / Support API / Show Attachment

Curl Command

Postman Collection Item JSON