Swift

Xero List Attachments for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to get information about the attachments for a particular Xero item. Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/xero-access-token.json")
    if success == false {
        print("\(jsonToken.lastErrorText!)")
        return
    }

    http.authToken = jsonToken.string(of: "access_token")

    // Replace the value here with an actual tenant ID obtained from this example:
    // Get Xero Tenant IDs
    http.setRequestHeader(name: "Xero-tenant-id", value: "83299b9e-5747-4a14-a18a-a6c94f824eb7")

    http.accept = "application/json"

    var url: String? = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/"

    // Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    http.setUrlVar(name: "Endpoint", value: "Invoices")

    // Guid is the ID of the item, such as the InvoiceID.
    http.setUrlVar(name: "Guid", value: "0032f627-3156-4d30-9b1c-4d3b994dc921")

    let resp = CkoHttpResponse()!
    success = http.httpNoBody(verb: "GET", url: url, response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("Response Status Code: \(resp.statusCode.intValue)")

    let jsonResponse = CkoJsonObject()!
    jsonResponse.load(json: resp.bodyStr)
    jsonResponse.emitCompact = false
    print("\(jsonResponse.emit()!)")

    if resp.statusCode.intValue != 200 {
        print("Failed.")
        return
    }

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

    // {
    //   "Id": "24bfbcb9-dec9-4d33-835c-8f165d776766",
    //   "Status": "OK",
    //   "ProviderName": "Chilkat2222",
    //   "DateTimeUTC": "\/Date(1587213296972)\/",
    //   "Attachments": [
    //     {
    //       "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
    //       "FileName": "penguins.jpg",
    //       "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
    //       "MimeType": "image/jpg",
    //       "ContentLength": 777835
    //     }
    //   ]
    // }

    var AttachmentID: String?
    var FileName: String?
    var v_Url: String?
    var MimeType: String?
    var ContentLength: Int

    var Id: String? = jsonResponse.string(of: "Id")
    var Status: String? = jsonResponse.string(of: "Status")
    var ProviderName: String? = jsonResponse.string(of: "ProviderName")
    var DateTimeUTC: String? = jsonResponse.string(of: "DateTimeUTC")
    var i: Int = 0
    var count_i: Int = jsonResponse.size(ofArray: "Attachments").intValue
    while i < count_i {
        jsonResponse.i = i
        AttachmentID = jsonResponse.string(of: "Attachments[i].AttachmentID")
        FileName = jsonResponse.string(of: "Attachments[i].FileName")
        v_Url = jsonResponse.string(of: "Attachments[i].Url")
        MimeType = jsonResponse.string(of: "Attachments[i].MimeType")
        ContentLength = jsonResponse.int(of: "Attachments[i].ContentLength").intValue
        i = i + 1
    }


}