(Excel) eBay -- Download Data using FileTransferService

Demonstrates how to download a data file using the eBay File Transfer API.

Note: This example requires Chilkat v9.5.0.67 or later.

Download Excel Class Modules Chilkat Excel Class Modules

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

' Use a previously obtained access token.  The token should look something like this:
' "AgAAAA**AQA ..."

accessToken = "EBAY_ACCESS_TOKEN"

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

Dim req As Chilkat.HttpRequest
Set req = Chilkat.NewHttpRequest

req.HttpVerb = "POST"
req.Path = "/FileTransferService"
req.ContentType = "application/xml"

' Build the XML body for the request.
Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml
xml.Tag = "downloadFileRequest"
Dim success As Boolean
success = xml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services")
xml.UpdateChildContent "taskReferenceId","50013004806"
xml.UpdateChildContent "fileReferenceId","50015579016"

success = req.LoadBodyFromString(xml.GetXml(),"utf-8")

' The XML body looks like this:

' 	<?xml version="1.0" encoding="UTF-8"?>
' 	<downloadFileRequest xmlns="http://www.ebay.com/marketplace/services">
' 	<taskReferenceId>50013004806</taskReferenceId>
' 	<fileReferenceId>50015579016</fileReferenceId>
' 	</downloadFileRequest>

req.AddHeader "X-EBAY-SOA-OPERATION-NAME","downloadFile"
req.AddHeader "X-EBAY-SOA-SECURITY-TOKEN",accessToken


Set resp = http.SynchronousRequest("storage.sandbox.ebay.com",443,True,req)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If


statusCode = resp.StatusCode
Debug.Print "Response status code = "; statusCode

Dim responseBody As Chilkat.BinData
Set responseBody = Chilkat.NewBinData
success = resp.GetBodyBd(responseBody)

' We can save the response body to a file for examination if we get an unanticipated response.  
' (It's binary, so it won't open well in a text editor.)
success = responseBody.WriteFile("qa_output/response.mime")

If (statusCode <> 200) Then
    Debug.Print "Failed."
    Exit Sub
End If

' The response body looks like this:

' 	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
' 	Content-Type: application/xop+xml; charset=utf-8; type="text/xml"
' 	Content-Transfer-Encoding: binary
' 	Content-ID: <0.urn:uuid:2B668636C1E17A4D4114925305818684242>
' 
' 	<?xml version='1.0' encoding='UTF-8'?>
' 	<downloadFileResponse xmlns="http://www.ebay.com/marketplace/services">
' 	<ack>Success</ack>
' 	<version>1.1.0</version>
' 	<timestamp>2017-04-18T15:49:41.868Z</timestamp>
' 	<fileAttachment>
' 	    <Size>587</Size>
' 	    <Data>
'                 <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:urn:uuid:A37C3C73E994C267F11492530585522"/>
' 	    </Data>
' 	</fileAttachment>
' 	</downloadFileResponse>
' 	--MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
' 	Content-Type: application/zip
' 	Content-Transfer-Encoding: binary
' 	Content-ID: <urn:uuid:A37C3C73E994C267F11492530585522>
' 
' 	<the binary bytes of the zip start here...>
' 

' Load the binary response into a MIME object.
Dim mime As Chilkat.Mime
Set mime = Chilkat.NewMime

success = mime.LoadMimeBd(responseBody)
If (success <> True) Then
    Debug.Print mime.LastErrorText
    Exit Sub
End If

' Make sure we have 2 sub-parts.  The 1st sub-part is the XML response, the 2nd sub-part
' is the zip containing the data.

' Note: The 2nd sub-part can be a "zip" or "gzip".  These are two different file formats.
' A zip is indicated with a Content-Type header equal to "application/zip",
' whereas a gzip is indicated with a Content-Type header equal to "application/x-gzip"
If (mime.NumParts <> 2) Then
    Debug.Print "Expected the MIME to have 2 parts."
    Debug.Print "NumParts = "; mime.NumParts
    Debug.Print "Failed."
    Exit Sub
End If

' Get the XML from the 1st MIME sub-part.

Set part0 = mime.GetPart(0)

downloadResponseXml = part0.GetBodyDecoded()
Dim xmlResp As Chilkat.Xml
Set xmlResp = Chilkat.NewXml
success = xmlResp.LoadXml(downloadResponseXml)
Debug.Print "Download Response XML:"
Debug.Print xmlResp.GetXml()

Debug.Print "----"

' Now get the zip from the second part (index=1), unzip, and examine..

Set part1 = mime.GetPart(1)
Dim zipData As Chilkat.BinData
Set zipData = Chilkat.NewBinData
' This example requires Chilkat v9.5.0.67 or later.
' The GetBodyBd method was added in v9.5.0.67.
success = part1.GetBodyBd(zipData)

' Check to see if we have a zip or gzip.
Dim sbContentType As Chilkat.StringBuilder
Set sbContentType = Chilkat.NewStringBuilder
success = sbContentType.Append(part1.ContentType)

Dim xmlFromZip As Chilkat.Xml
Set xmlFromZip = Chilkat.NewXml

If (sbContentType.Contains("gzip",False) = True) Then
    ' This is a gzip compressed file.
    Dim gzip As Chilkat.Gzip
    Set gzip = Chilkat.NewGzip

    ' in-place uncompress the data.
    ' Note: The UncompressBd method was added in Chilkat v9.5.0.67
    success = gzip.UncompressBd(zipData)
    If (success <> True) Then
        Debug.Print gzip.LastErrorText
        Exit Sub
    End If

    success = xmlFromZip.LoadXml(zipData.GetString("utf-8"))

Else
    ' This is a zip archive.

    ' Load the body into a Zip object.
    Dim zip As Chilkat.Zip
    Set zip = Chilkat.NewZip
    success = zip.OpenBd(zipData)
    If (success <> True) Then
        Debug.Print zip.LastErrorText
        Exit Sub
    End If

    ' Save the .zip to a file (so we can examine it for debugging if something is not as expected)
    success = zipData.WriteFile("qa_output/ebay_data.zip")

    ' The zip should contain a single XML file.
    If (zip.NumEntries <> 1) Then
        Debug.Print "Expected the .zip to have 1 entry."
        Debug.Print "NumEntries = "; zip.NumEntries
        Debug.Print "Failed."
        Exit Sub
    End If


    Set entry = zip.GetEntryByIndex(0)

    success = xmlFromZip.LoadXml(entry.UnzipToString(0,"utf-8"))

End If

Debug.Print "XML contained in the zip:"
Debug.Print xmlFromZip.GetXml()
Debug.Print "----"

Debug.Print "Success."