Chilkat Online Tools

Swift3 / Support API / Show Macro Replica

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "login"
    http.password = "password"

    let queryParams = CkoJsonObject()!
    queryParams.update("macro_id", value: "<integer>")
    queryParams.update("ticket_id", value: "<integer>")

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://example.zendesk.com/api/v2/macros/new", json: queryParams)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var field: String?
    var value: String?

    var Title: String? = jResp.string(of: "macro.title")
    var Active: String? = jResp.string(of: "macro.active")
    var Created_at: String? = jResp.string(of: "macro.created_at")
    var Default: String? = jResp.string(of: "macro.default")
    var Description: String? = jResp.string(of: "macro.description")
    var Id: String? = jResp.string(of: "macro.id")
    var Position: String? = jResp.string(of: "macro.position")
    var Utc: String? = jResp.string(of: "macro.restriction.utc")
    var Sint_c: String? = jResp.string(of: "macro.restriction.sint_c")
    var Updated_at: String? = jResp.string(of: "macro.updated_at")
    var v_Url: String? = jResp.string(of: "macro.url")
    var App_installation: String? = jResp.string(of: "macro.app_installation")
    var Categories: String? = jResp.string(of: "macro.categories")
    var Permissions: String? = jResp.string(of: "macro.permissions")
    var Usage_1h: String? = jResp.string(of: "macro.usage_1h")
    var Usage_7d: String? = jResp.string(of: "macro.usage_7d")
    var Usage_24h: String? = jResp.string(of: "macro.usage_24h")
    var Usage_30d: String? = jResp.string(of: "macro.usage_30d")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "macro.actions").intValue
    while i < count_i {
        jResp.i = i
        field = jResp.string(of: "macro.actions[i].field")
        value = jResp.string(of: "macro.actions[i].value")
        i = i + 1
    }


}

Curl Command

curl  -u login:password -G -d "macro_id=%3Cinteger%3E"
	-d "ticket_id=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/new

Postman Collection Item JSON

{
  "name": "Show Macro Replica",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros/new?macro_id=<integer>&ticket_id=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros",
        "new"
      ],
      "query": [
        {
          "key": "macro_id",
          "value": "<integer>",
          "description": "(Required) The ID of the macro to replicate"
        },
        {
          "key": "ticket_id",
          "value": "<integer>",
          "description": "(Required) The ID of the ticket from which to build a macro replica"
        }
      ]
    },
    "description": "Returns an unpersisted macro representation derived from a ticket or macro.\n\nThe endpoint takes one of the following query parameters: `macro_id` or `ticket_id`. If you include both, `macro_id` is used.\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/new?macro_id=<integer>&ticket_id=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros",
            "new"
          ],
          "query": [
            {
              "key": "macro_id",
              "value": "<integer>",
              "description": "(Required) The ID of the macro to replicate"
            },
            {
              "key": "ticket_id",
              "value": "<integer>",
              "description": "(Required) The ID of the ticket from which to build a macro replica"
            }
          ]
        }
      },
      "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}"
    }
  ]
}