(Lianja) eBay -- Download Data using FileTransferService

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

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Lianja Extension Download Chilkat Lianja Extension

llSuccess = .F.

// 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 ..."
lcAccessToken = "EBAY_ACCESS_TOKEN"

loHttp = createobject("CkHttp")

loReq = createobject("CkHttpRequest")

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

// Build the XML body for the request.
loXml = createobject("CkXml")
loXml.Tag = "downloadFileRequest"
loXml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services")
loXml.UpdateChildContent("taskReferenceId","50013004806")
loXml.UpdateChildContent("fileReferenceId","50015579016")

loReq.LoadBodyFromString(loXml.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>

loReq.AddHeader("X-EBAY-SOA-OPERATION-NAME","downloadFile")
loReq.AddHeader("X-EBAY-SOA-SECURITY-TOKEN",lcAccessToken)

loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpSReq("storage.sandbox.ebay.com",443,.T.,loReq,loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    release loXml
    release loResp
    return
endif

lnStatusCode = loResp.StatusCode
? "Response status code = " + str(lnStatusCode)

loResponseBody = createobject("CkBinData")
loResp.GetBodyBd(loResponseBody)

// 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.)
loResponseBody.WriteFile("qa_output/response.mime")

if (lnStatusCode <> 200) then
    ? "Failed."
    release loHttp
    release loReq
    release loXml
    release loResp
    release loResponseBody
    return
endif

// 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.
loMime = createobject("CkMime")
llSuccess = loMime.LoadMimeBd(loResponseBody)
if (llSuccess = .F.) then
    ? loMime.LastErrorText
    release loHttp
    release loReq
    release loXml
    release loResp
    release loResponseBody
    release loMime
    return
endif

// 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 (loMime.NumParts <> 2) then
    ? "Expected the MIME to have 2 parts."
    ? "NumParts = " + str(loMime.NumParts)
    ? "Failed."
    release loHttp
    release loReq
    release loXml
    release loResp
    release loResponseBody
    release loMime
    return
endif

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

loPart0 = createobject("CkMime")
llSuccess = loMime.PartAt(0,loPart0)
if (llSuccess = .F.) then
    ? loMime.LastErrorText
    release loHttp
    release loReq
    release loXml
    release loResp
    release loResponseBody
    release loMime
    release loPart0
    return
endif

lcDownloadResponseXml = loPart0.GetBodyDecoded()
loXmlResp = createobject("CkXml")
loXmlResp.LoadXml(lcDownloadResponseXml)
? "Download Response XML:"
? loXmlResp.GetXml()

? "----"

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

loPart1 = createobject("CkMime")
llSuccess = loMime.PartAt(1,loPart1)
if (llSuccess = .F.) then
    ? loMime.LastErrorText
    release loHttp
    release loReq
    release loXml
    release loResp
    release loResponseBody
    release loMime
    release loPart0
    release loXmlResp
    release loPart1
    return
endif

loZipData = createobject("CkBinData")
loPart1.GetBodyBd(loZipData)

// Check to see if we have a zip or gzip.
loSbContentType = createobject("CkStringBuilder")
loSbContentType.Append(loPart1.ContentType)

loXmlFromZip = createobject("CkXml")

if (loSbContentType.Contains("gzip",.F.) = .T.) then
    // This is a gzip compressed file.
    loGzip = createobject("CkGzip")

    // in-place uncompress the data.
    // Note: The UncompressBd method was added in Chilkat v9.5.0.67
    llSuccess = loGzip.UncompressBd(loZipData)
    if (llSuccess = .F.) then
        ? loGzip.LastErrorText
        release loHttp
        release loReq
        release loXml
        release loResp
        release loResponseBody
        release loMime
        release loPart0
        release loXmlResp
        release loPart1
        release loZipData
        release loSbContentType
        release loXmlFromZip
        release loGzip
        return
    endif

    loXmlFromZip.LoadXml(loZipData.GetString("utf-8"))

else
    // This is a zip archive.

    // Load the body into a Zip object.
    loZip = createobject("CkZip")
    llSuccess = loZip.OpenBd(loZipData)
    if (llSuccess = .F.) then
        ? loZip.LastErrorText
        release loHttp
        release loReq
        release loXml
        release loResp
        release loResponseBody
        release loMime
        release loPart0
        release loXmlResp
        release loPart1
        release loZipData
        release loSbContentType
        release loXmlFromZip
        release loGzip
        release loZip
        return
    endif

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

    // The zip should contain a single XML file.
    if (loZip.NumEntries <> 1) then
        ? "Expected the .zip to have 1 entry."
        ? "NumEntries = " + str(loZip.NumEntries)
        ? "Failed."
        release loHttp
        release loReq
        release loXml
        release loResp
        release loResponseBody
        release loMime
        release loPart0
        release loXmlResp
        release loPart1
        release loZipData
        release loSbContentType
        release loXmlFromZip
        release loGzip
        release loZip
        return
    endif

    loEntry = createobject("CkZipEntry")
    llSuccess = loZip.EntryAt(0,loEntry)
    if (llSuccess = .F.) then
        ? loZip.LastErrorText
        release loHttp
        release loReq
        release loXml
        release loResp
        release loResponseBody
        release loMime
        release loPart0
        release loXmlResp
        release loPart1
        release loZipData
        release loSbContentType
        release loXmlFromZip
        release loGzip
        release loZip
        release loEntry
        return
    endif

    loXmlFromZip.LoadXml(loEntry.UnzipToString(0,"utf-8"))
endif

? "XML contained in the zip:"
? loXmlFromZip.GetXml()
? "----"

? "Success."


release loHttp
release loReq
release loXml
release loResp
release loResponseBody
release loMime
release loPart0
release loXmlResp
release loPart1
release loZipData
release loSbContentType
release loXmlFromZip
release loGzip
release loZip
release loEntry