(Excel) Xero Upload File (Files API)

Demonstrates how to upload a file to a Xero folder.

Note: This example requires Chilkat v9.5.0.64 or greater.

Download Excel Class Modules Chilkat Excel Class Modules

' Note: Requires Chilkat v9.5.0.64 or greater.

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' Before sending REST API calls, the REST object needs to be
' initialized for OAuth1.
' See Xero 2-Legged OAuth1 Setup for sample code.

' Assuming the REST object's OAuth1 authenticator is setup, and the initial
' connection was made, we may now send REST HTTP requests..

' --------------------------------------------------------------
' This example will upload a file to a folder using the Xero FILES API


folderID = "0ffca059-f2f1-4271-8de9-4b87c8c2c638"
' This JPG image can be downloaded from https://www.chilkatsoft.com/syncedImages/penguins.jpg

filename = "penguins.jpg"

Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/files.xro/1.0/Files/{FolderId}")

numReplaced = sbPath.Replace("{FolderId}",folderID)

success = rest.AddHeader("Content-Type","image/jpeg")

' Load the JPG image from a file.
Dim jpgData As Chilkat.BinData
Set jpgData = Chilkat.NewBinData
success = jpgData.LoadFile("qa_data/jpg/penguins.jpg")

' We could alternatively get it from a URL like this:
Dim jpgDataFromWeb As Chilkat.BinData
Set jpgDataFromWeb = Chilkat.NewBinData
Dim http As Chilkat.Http
Set http = Chilkat.NewHttp
success = http.QuickGetBd("https://www.chilkatsoft.com/syncedImages/penguins.jpg",jpgDataFromWeb)
If (success <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' 
' Put the file data in the 1st sub-part in the multipart/form-data request we'll be sending.
rest.PartSelector = "1"
success = rest.SetMultipartBodyBd(jpgData)

' Set request headers in the 1st subpart (as indicated by the PartSelector)
success = rest.AddHeader("Content-Type","image/jpeg")
success = rest.AddHeader("Content-Disposition","multipart/form-data; name=Xero; filename=penguins.jpg")

' Restore the PartSelector to an empty string.
rest.PartSelector = ""

success = rest.AddHeader("Content-Type","multipart/form-data")

' Upload with a multipart/form-data POST

responseJson = rest.FullRequestMultipart("POST",sbPath.GetAsString())
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.Load(responseJson)
json.EmitCompact = False

' A 201 response is expected for actual success.
' The Xero documentation doesn't explicitly state it, but that's what we've found in testing.
' To be safe, we'll check for either 200 or 201.
If ((rest.ResponseStatusCode <> 200) And (rest.ResponseStatusCode <> 201)) Then
    Debug.Print json.Emit()
    Exit Sub
End If

' Examine the JSON response
Debug.Print json.Emit()

' A successful response looks like this:

' 	{ 
' 	  "Name": "penguins.jpg",
' 	  "MimeType": "image/jpeg",
' 	  "Size": 777835,
' 	  "CreatedDateUtc": "2016-11-12T15:31:53.4230000",
' 	  "UpdatedDateUtc": "2016-11-12T15:31:53.4230000",
' 	  "User": { 
' 	    "Name": "admin@chilkatsoft.com",
' 	    "FirstName": "Matthew",
' 	    "LastName": "Smith",
' 	    "FullName": "Matthew Smith",
' 	    "Id": "c362fe42-cb12-461f-b84a-c281c1a74841"
' 	  },
' 	  "FolderId": "0ffca059-f2f1-4271-8de9-4b87c8c2c638",
' 	  "Id": "f042e9a3-a31d-4595-b8b3-6030ea6084bb"
' 	}