Sample code for 30+ languages & platforms
Visual FoxPro

eBay -- Download Data using FileTransferService

See more eBay Examples

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

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro
Visual FoxPro 
LOCAL lnSuccess
LOCAL lcAccessToken
LOCAL loHttp
LOCAL loReq
LOCAL loXml
LOCAL loResp
LOCAL lnStatusCode
LOCAL loResponseBody
LOCAL loMime
LOCAL loPart0
LOCAL lcDownloadResponseXml
LOCAL loXmlResp
LOCAL loPart1
LOCAL loZipData
LOCAL loSbContentType
LOCAL loXmlFromZip
LOCAL loGzip
LOCAL loZip
LOCAL loEntry

lnSuccess = 0

* 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('Chilkat.Http')

loReq = CreateObject('Chilkat.HttpRequest')

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

* Build the XML body for the request.
loXml = CreateObject('Chilkat.Xml')
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('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpSReq("storage.sandbox.ebay.com",443,1,loReq,loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loXml
    RELEASE loResp
    CANCEL
ENDIF

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

loResponseBody = CreateObject('Chilkat.BinData')
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
    CANCEL
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('Chilkat.Mime')
lnSuccess = loMime.LoadMimeBd(loResponseBody)
IF (lnSuccess = 0) THEN
    ? loMime.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loXml
    RELEASE loResp
    RELEASE loResponseBody
    RELEASE loMime
    CANCEL
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
    CANCEL
ENDIF

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

loPart0 = CreateObject('Chilkat.Mime')
lnSuccess = loMime.PartAt(0,loPart0)
IF (lnSuccess = 0) THEN
    ? loMime.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loXml
    RELEASE loResp
    RELEASE loResponseBody
    RELEASE loMime
    RELEASE loPart0
    CANCEL
ENDIF

lcDownloadResponseXml = loPart0.GetBodyDecoded()
loXmlResp = CreateObject('Chilkat.Xml')
loXmlResp.LoadXml(lcDownloadResponseXml)
? "Download Response XML:"
? loXmlResp.GetXml()

? "----"

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

loPart1 = CreateObject('Chilkat.Mime')
lnSuccess = loMime.PartAt(1,loPart1)
IF (lnSuccess = 0) THEN
    ? loMime.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loXml
    RELEASE loResp
    RELEASE loResponseBody
    RELEASE loMime
    RELEASE loPart0
    RELEASE loXmlResp
    RELEASE loPart1
    CANCEL
ENDIF

loZipData = CreateObject('Chilkat.BinData')
loPart1.GetBodyBd(loZipData)

* Check to see if we have a zip or gzip.
loSbContentType = CreateObject('Chilkat.StringBuilder')
loSbContentType.Append(loPart1.ContentType)

loXmlFromZip = CreateObject('Chilkat.Xml')

IF (loSbContentType.Contains("gzip",0) = 1) THEN
    * This is a gzip compressed file.
    loGzip = CreateObject('Chilkat.Gzip')

    * in-place uncompress the data.
    * Note: The UncompressBd method was added in Chilkat v9.5.0.67
    lnSuccess = loGzip.UncompressBd(loZipData)
    IF (lnSuccess = 0) 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
        CANCEL
    ENDIF

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

ELSE
    * This is a zip archive.

    * Load the body into a Zip object.
    loZip = CreateObject('Chilkat.Zip')
    lnSuccess = loZip.OpenBd(loZipData)
    IF (lnSuccess = 0) 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
        CANCEL
    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
        CANCEL
    ENDIF

    loEntry = CreateObject('Chilkat.ZipEntry')
    lnSuccess = loZip.EntryAt(0,loEntry)
    IF (lnSuccess = 0) 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
        CANCEL
    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