Ruby

Xero Upload Attachment

Upload an attachment. (POST an attachment).

Note: Requires Chilkat v9.5.0.64 or greater.

Ruby

require 'chilkat'

success = false

# 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.

rest = Chilkat::CkRest.new()

# 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 an image attachment to a receipt.

endPoint = "Receipts"
receiptID = "c4f40e59-c390-0001-caff-ce731c707d00"
# This JPG image can be downloaded from https://www.chilkatsoft.com/syncedImages/penguins.jpg
filename = "penguins.jpg"

sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/api.xro/2.0/{Endpoint}/{Guid}/Attachments/{Filename}")
numReplaced = sbPath.Replace("{Endpoint}",endPoint)
numReplaced = sbPath.Replace("{Guid}",receiptID)
numReplaced = sbPath.Replace("{Filename}",filename)

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

# Load the JPG image from a file.
jpgData = Chilkat::CkBinData.new()
success = jpgData.LoadFile("qa_data/jpg/penguins.jpg")

# We could alternatively get it from a URL like this:
jpgDataFromWeb = Chilkat::CkBinData.new()
http = Chilkat::CkHttp.new()
success = http.QuickGetBd("https://www.chilkatsoft.com/syncedImages/penguins.jpg",jpgDataFromWeb)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

# Upload with a POST
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestBd("POST",sbPath.getAsString(),jpgData,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# A 200 response is expected for actual success.
if (rest.get_ResponseStatusCode() != 200)
    print sbResponseBody.getAsString() + "\n";
    exit
end

# Examine the XML response
print sbResponseBody.getAsString() + "\n";

# A successful response looks like this:

# 	<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
# 	  <Id>d82568cd-d222-49e6-b713-880b6edb0606</Id>
# 	  <Status>OK</Status>
# 	  <ProviderName>ChilkatPrivate</ProviderName>
# 	  <DateTimeUTC>2016-11-11T14:17:49.5922609Z</DateTimeUTC>
# 	  <Attachments>
# 	    <Attachment>
# 	      <AttachmentID>0edcddc8-325f-40c7-b950-8c71f14afc7c</AttachmentID>
# 	      <FileName>penguins.jpg</FileName>
# 	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/penguins.jpg</Url>
# 	      <MimeType>image/jpg</MimeType>
# 	      <ContentLength>777835</ContentLength>
# 	    </Attachment>
# 	  </Attachments>
# 	</Response>