Chilkat Online Tools

Swift / Support API / Show Ticket After Changes

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"

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

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/macros/:macro_id/apply", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    // {
    //   "result": {
    //     "ticket": {
    //       "assignee_id": "<integer>",
    //       "comment": {
    //         "body": "<string>",
    //         "public": "<boolean>",
    //         "scoped_body": [
    //           [
    //             "<string>",
    //             "<string>"
    //           ],
    //           [
    //             "<string>",
    //             "<string>"
    //           ]
    //         ]
    //       },
    //       "fields": {
    //         "id": "<integer>",
    //         "value": "<string>"
    //       },
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "url": "<string>"
    //     }
    //   }
    // }

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

    var j: Int
    var count_j: Int
    var strVal: String?

    var Assignee_id: String? = jResp.StringOf("result.ticket.assignee_id")
    var Body: String? = jResp.StringOf("result.ticket.comment.body")
    var v_Public: String? = jResp.StringOf("result.ticket.comment.public")
    var Id: String? = jResp.StringOf("result.ticket.fields.id")
    var Value: String? = jResp.StringOf("result.ticket.fields.value")
    var Group_id: String? = jResp.StringOf("result.ticket.group_id")
    var TicketId: String? = jResp.StringOf("result.ticket.id")
    var v_Url: String? = jResp.StringOf("result.ticket.url")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("result.ticket.comment.scoped_body").intValue
    while i < count_i {
        jResp.I = i
        j = 0
        count_j = jResp.SizeOfArray("result.ticket.comment.scoped_body[i]").intValue
        while j < count_j {
            jResp.J = j
            strVal = jResp.StringOf("result.ticket.comment.scoped_body[i][j]")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Ticket After Changes",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/macros/:macro_id/apply",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "macros",
        ":macro_id",
        "apply"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        },
        {
          "key": "macro_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns the full ticket object as it would be after applying the macro to the ticket.\nIt doesn't actually change the ticket.\n\nTo get only the ticket fields that would be changed by the macro,\nsee [Show Changes to Ticket](#show-changes-to-ticket).\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/tickets/:ticket_id/macros/:macro_id/apply",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "macros",
            ":macro_id",
            "apply"
          ],
          "variable": [
            {
              "key": "ticket_id"
            },
            {
              "key": "macro_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"result\": {\n    \"ticket\": {\n      \"assignee_id\": \"<integer>\",\n      \"comment\": {\n        \"body\": \"<string>\",\n        \"public\": \"<boolean>\",\n        \"scoped_body\": [\n          [\n            \"<string>\",\n            \"<string>\"\n          ],\n          [\n            \"<string>\",\n            \"<string>\"\n          ]\n        ]\n      },\n      \"fields\": {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      },\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  }\n}"
    }
  ]
}