Chilkat Online Tools

Perl / Support API / Show Macro

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$http->SetRequestHeader("Accept","application/json");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://example.zendesk.com/api/v2/macros/:macro_id",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "macro": {
#     "actions": [
#       {
#         "field": "<string>",
#         "value": "<string>"
#       },
#       {
#         "field": "<string>",
#         "value": "<string>"
#       }
#     ],
#     "title": "<string>",
#     "active": "<boolean>",
#     "created_at": "<dateTime>",
#     "default": "<boolean>",
#     "description": "<string>",
#     "id": "<integer>",
#     "position": "<integer>",
#     "restriction": {
#       "utc": -57663786.73485631,
#       "sint_c": 56026975.00248328
#     },
#     "updated_at": "<dateTime>",
#     "url": "<string>",
#     "app_installation": "<string>",
#     "categories": "<string>",
#     "permissions": "<string>",
#     "usage_1h": "<integer>",
#     "usage_7d": "<integer>",
#     "usage_24h": "<integer>",
#     "usage_30d": "<integer>"
#   }
# }

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

$Title = $jResp->stringOf("macro.title");
$Active = $jResp->stringOf("macro.active");
$Created_at = $jResp->stringOf("macro.created_at");
$Default = $jResp->stringOf("macro.default");
$Description = $jResp->stringOf("macro.description");
$Id = $jResp->stringOf("macro.id");
$Position = $jResp->stringOf("macro.position");
$Utc = $jResp->stringOf("macro.restriction.utc");
$Sint_c = $jResp->stringOf("macro.restriction.sint_c");
$Updated_at = $jResp->stringOf("macro.updated_at");
$v_Url = $jResp->stringOf("macro.url");
$App_installation = $jResp->stringOf("macro.app_installation");
$Categories = $jResp->stringOf("macro.categories");
$Permissions = $jResp->stringOf("macro.permissions");
$Usage_1h = $jResp->stringOf("macro.usage_1h");
$Usage_7d = $jResp->stringOf("macro.usage_7d");
$Usage_24h = $jResp->stringOf("macro.usage_24h");
$Usage_30d = $jResp->stringOf("macro.usage_30d");
$i = 0;
$count_i = $jResp->SizeOfArray("macro.actions");
while ($i < $count_i) {
    $jResp->put_I($i);
    $field = $jResp->stringOf("macro.actions[i].field");
    $value = $jResp->stringOf("macro.actions[i].value");
    $i = $i + 1;
}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/:macro_id

Postman Collection Item JSON

{
  "name": "Show Macro",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros/:macro_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros",
        ":macro_id"
      ],
      "variable": [
        {
          "key": "macro_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros",
            ":macro_id"
          ],
          "variable": [
            {
              "key": "macro_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"macro\": {\n    \"actions\": [\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"restriction\": {\n      \"utc\": -57663786.73485631,\n      \"sint_c\": 56026975.00248328\n    },\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"app_installation\": \"<string>\",\n    \"categories\": \"<string>\",\n    \"permissions\": \"<string>\",\n    \"usage_1h\": \"<integer>\",\n    \"usage_7d\": \"<integer>\",\n    \"usage_24h\": \"<integer>\",\n    \"usage_30d\": \"<integer>\"\n  }\n}"
    }
  ]
}