phpExt / Support API / List Macro Attachments
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$http->put_BasicAuth(true);
$http->put_Login('login');
$http->put_Password('password');
$http->SetRequestHeader('Accept','application/json');
$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/macros/:macro_id/attachments',$sbResponseBody);
if ($success == false) {
print $http->lastErrorText() . "\n";
exit;
}
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->lastHeader() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "macro_attachments": [
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "created_at": "<dateTime>",
// "filename": "<string>",
// "id": "<integer>",
// "size": "<integer>"
// },
// {
// "content_type": "<string>",
// "content_url": "<string>",
// "created_at": "<dateTime>",
// "filename": "<string>",
// "id": "<integer>",
// "size": "<integer>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$i = 0;
$count_i = $jResp->SizeOfArray('macro_attachments');
while ($i < $count_i) {
$jResp->put_I($i);
$content_type = $jResp->stringOf('macro_attachments[i].content_type');
$content_url = $jResp->stringOf('macro_attachments[i].content_url');
$created_at = $jResp->stringOf('macro_attachments[i].created_at');
$filename = $jResp->stringOf('macro_attachments[i].filename');
$id = $jResp->stringOf('macro_attachments[i].id');
$size = $jResp->stringOf('macro_attachments[i].size');
$i = $i + 1;
}
?>
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/:macro_id/attachments
Postman Collection Item JSON
{
"name": "List Macro Attachments",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/macros/:macro_id/attachments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id",
"attachments"
],
"variable": [
{
"key": "macro_id",
"value": "<integer>"
}
]
},
"description": "Lists the attachments associated with a macro.\n\n#### Allowed For\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/macros/:macro_id/attachments",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"macros",
":macro_id",
"attachments"
],
"variable": [
{
"key": "macro_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"macro_attachments\": [\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"filename\": \"<string>\",\n \"id\": \"<integer>\",\n \"size\": \"<integer>\"\n },\n {\n \"content_type\": \"<string>\",\n \"content_url\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"filename\": \"<string>\",\n \"id\": \"<integer>\",\n \"size\": \"<integer>\"\n }\n ]\n}"
}
]
}