Chilkat Online Tools

Xojo / Support API / Show Macro

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/macros/:macro_id",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

Dim field As String
Dim value As String

Dim Title As String
Title = jResp.StringOf("macro.title")
Dim Active As String
Active = jResp.StringOf("macro.active")
Dim Created_at As String
Created_at = jResp.StringOf("macro.created_at")
Dim Default As String
Default = jResp.StringOf("macro.default")
Dim Description As String
Description = jResp.StringOf("macro.description")
Dim Id As String
Id = jResp.StringOf("macro.id")
Dim Position As String
Position = jResp.StringOf("macro.position")
Dim Utc As String
Utc = jResp.StringOf("macro.restriction.utc")
Dim Sint_c As String
Sint_c = jResp.StringOf("macro.restriction.sint_c")
Dim Updated_at As String
Updated_at = jResp.StringOf("macro.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("macro.url")
Dim App_installation As String
App_installation = jResp.StringOf("macro.app_installation")
Dim Categories As String
Categories = jResp.StringOf("macro.categories")
Dim Permissions As String
Permissions = jResp.StringOf("macro.permissions")
Dim Usage_1h As String
Usage_1h = jResp.StringOf("macro.usage_1h")
Dim Usage_7d As String
Usage_7d = jResp.StringOf("macro.usage_7d")
Dim Usage_24h As String
Usage_24h = jResp.StringOf("macro.usage_24h")
Dim Usage_30d As String
Usage_30d = jResp.StringOf("macro.usage_30d")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("macro.actions")
While i < count_i
    jResp.I = i
    field = jResp.StringOf("macro.actions[i].field")
    value = jResp.StringOf("macro.actions[i].value")
    i = i + 1
Wend

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