Chilkat Online Tools

Swift / Support API / Suspended Ticket Attachments

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")

    var resp: CkoHttpResponse? = http.QuickRequest("POST", url: "https://example.zendesk.com/api/v2/suspended_tickets/attachments")
    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)

    // {
    //   "upload": {
    //     "attachments": [
    //       {
    //         "content_type": "<string>",
    //         "content_url": "<string>",
    //         "deleted": "<boolean>",
    //         "file_name": "<string>",
    //         "height": "<string>",
    //         "id": "<integer>",
    //         "inline": "<boolean>",
    //         "malware_access_override": "<boolean>",
    //         "malware_scan_result": "<string>",
    //         "mapped_content_url": "<string>",
    //         "size": "<integer>",
    //         "url": "<string>",
    //         "width": "<string>",
    //         "thumbnails": [
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           },
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           }
    //         ]
    //       },
    //       {
    //         "content_type": "<string>",
    //         "content_url": "<string>",
    //         "deleted": "<boolean>",
    //         "file_name": "<string>",
    //         "height": "<string>",
    //         "id": "<integer>",
    //         "inline": "<boolean>",
    //         "malware_access_override": "<boolean>",
    //         "malware_scan_result": "<string>",
    //         "mapped_content_url": "<string>",
    //         "size": "<integer>",
    //         "url": "<string>",
    //         "width": "<string>",
    //         "thumbnails": [
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           },
    //           {
    //             "content_type": "<string>",
    //             "content_url": "<string>",
    //             "deleted": "<boolean>",
    //             "file_name": "<string>",
    //             "height": "<string>",
    //             "id": "<integer>",
    //             "inline": "<boolean>",
    //             "malware_access_override": "<boolean>",
    //             "malware_scan_result": "<string>",
    //             "mapped_content_url": "<string>",
    //             "size": "<integer>",
    //             "url": "<string>",
    //             "width": "<string>"
    //           }
    //         ]
    //       }
    //     ],
    //     "token": "<string>"
    //   }
    // }

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

    var content_type: String?
    var content_url: String?
    var deleted: String?
    var file_name: String?
    var height: String?
    var id: String?
    var inline: String?
    var malware_access_override: String?
    var malware_scan_result: String?
    var mapped_content_url: String?
    var size: String?
    var url: String?
    var width: String?
    var j: Int
    var count_j: Int

    var Token: String? = jResp.StringOf("upload.token")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("upload.attachments").intValue
    while i < count_i {
        jResp.I = i
        content_type = jResp.StringOf("upload.attachments[i].content_type")
        content_url = jResp.StringOf("upload.attachments[i].content_url")
        deleted = jResp.StringOf("upload.attachments[i].deleted")
        file_name = jResp.StringOf("upload.attachments[i].file_name")
        height = jResp.StringOf("upload.attachments[i].height")
        id = jResp.StringOf("upload.attachments[i].id")
        inline = jResp.StringOf("upload.attachments[i].inline")
        malware_access_override = jResp.StringOf("upload.attachments[i].malware_access_override")
        malware_scan_result = jResp.StringOf("upload.attachments[i].malware_scan_result")
        mapped_content_url = jResp.StringOf("upload.attachments[i].mapped_content_url")
        size = jResp.StringOf("upload.attachments[i].size")
        url = jResp.StringOf("upload.attachments[i].url")
        width = jResp.StringOf("upload.attachments[i].width")
        j = 0
        count_j = jResp.SizeOfArray("upload.attachments[i].thumbnails").intValue
        while j < count_j {
            jResp.J = j
            content_type = jResp.StringOf("upload.attachments[i].thumbnails[j].content_type")
            content_url = jResp.StringOf("upload.attachments[i].thumbnails[j].content_url")
            deleted = jResp.StringOf("upload.attachments[i].thumbnails[j].deleted")
            file_name = jResp.StringOf("upload.attachments[i].thumbnails[j].file_name")
            height = jResp.StringOf("upload.attachments[i].thumbnails[j].height")
            id = jResp.StringOf("upload.attachments[i].thumbnails[j].id")
            inline = jResp.StringOf("upload.attachments[i].thumbnails[j].inline")
            malware_access_override = jResp.StringOf("upload.attachments[i].thumbnails[j].malware_access_override")
            malware_scan_result = jResp.StringOf("upload.attachments[i].thumbnails[j].malware_scan_result")
            mapped_content_url = jResp.StringOf("upload.attachments[i].thumbnails[j].mapped_content_url")
            size = jResp.StringOf("upload.attachments[i].thumbnails[j].size")
            url = jResp.StringOf("upload.attachments[i].thumbnails[j].url")
            width = jResp.StringOf("upload.attachments[i].thumbnails[j].width")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/suspended_tickets/attachments

Postman Collection Item JSON

{
  "name": "Suspended Ticket Attachments",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/suspended_tickets/attachments",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "suspended_tickets",
        "attachments"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<number>",
          "description": "(Required) id of the suspended ticket"
        }
      ]
    },
    "description": "Makes copies of any attachments on a suspended ticket and returns them as [attachment tokens](/api-reference/ticketing/tickets/ticket-attachments/). If the  ticket is manually recovered, you can include the attachment tokens on the new ticket.\n\n#### Allowed For\n\n* Unrestricted agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/suspended_tickets/attachments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "suspended_tickets",
            "attachments"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"upload\": {\n    \"attachments\": [\n      {\n        \"content_type\": \"<string>\",\n        \"content_url\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"file_name\": \"<string>\",\n        \"height\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"inline\": \"<boolean>\",\n        \"malware_access_override\": \"<boolean>\",\n        \"malware_scan_result\": \"<string>\",\n        \"mapped_content_url\": \"<string>\",\n        \"size\": \"<integer>\",\n        \"url\": \"<string>\",\n        \"width\": \"<string>\",\n        \"thumbnails\": [\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          },\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          }\n        ]\n      },\n      {\n        \"content_type\": \"<string>\",\n        \"content_url\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"file_name\": \"<string>\",\n        \"height\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"inline\": \"<boolean>\",\n        \"malware_access_override\": \"<boolean>\",\n        \"malware_scan_result\": \"<string>\",\n        \"mapped_content_url\": \"<string>\",\n        \"size\": \"<integer>\",\n        \"url\": \"<string>\",\n        \"width\": \"<string>\",\n        \"thumbnails\": [\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          },\n          {\n            \"content_type\": \"<string>\",\n            \"content_url\": \"<string>\",\n            \"deleted\": \"<boolean>\",\n            \"file_name\": \"<string>\",\n            \"height\": \"<string>\",\n            \"id\": \"<integer>\",\n            \"inline\": \"<boolean>\",\n            \"malware_access_override\": \"<boolean>\",\n            \"malware_scan_result\": \"<string>\",\n            \"mapped_content_url\": \"<string>\",\n            \"size\": \"<integer>\",\n            \"url\": \"<string>\",\n            \"width\": \"<string>\"\n          }\n        ]\n      }\n    ],\n    \"token\": \"<string>\"\n  }\n}"
    }
  ]
}