(PowerShell) 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.

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$req = New-Object Chilkat.HttpRequest

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

# Build the XML body for the request.
$xml = New-Object Chilkat.Xml
$xml.Tag = "downloadFileRequest"
$xml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services")
$xml.UpdateChildContent("taskReferenceId","50013004806")
$xml.UpdateChildContent("fileReferenceId","50015579016")

$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)

$resp = $http.SynchronousRequest("storage.sandbox.ebay.com",443,$true,$req)
if ($http.LastMethodSuccess -ne $true) {
    $($http.LastErrorText)
    exit
}

$statusCode = $resp.StatusCode
$("Response status code = " + $statusCode)

$responseBody = New-Object Chilkat.BinData
$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.)
$responseBody.WriteFile("qa_output/response.mime")

if ($statusCode -ne 200) {
    $("Failed.")
    exit
}

# 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.
$mime = New-Object Chilkat.Mime
$success = $mime.LoadMimeBd($responseBody)
if ($success -ne $true) {
    $($mime.LastErrorText)
    exit
}

# 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 -ne 2) {
    $("Expected the MIME to have 2 parts.")
    $("NumParts = " + $mime.NumParts)
    $("Failed.")
    exit
}

# Get the XML from the 1st MIME sub-part.
$part0 = $mime.GetPart(0)
$downloadResponseXml = $part0.GetBodyDecoded()
$xmlResp = New-Object Chilkat.Xml
$xmlResp.LoadXml($downloadResponseXml)
$("Download Response XML:")
$($xmlResp.GetXml())

$("----")

# Now get the zip from the second part (index=1), unzip, and examine..
$part1 = $mime.GetPart(1)
$zipData = New-Object Chilkat.BinData
# This example requires Chilkat v9.5.0.67 or later.
# The GetBodyBd method was added in v9.5.0.67.
$part1.GetBodyBd($zipData)

# Check to see if we have a zip or gzip.
$sbContentType = New-Object Chilkat.StringBuilder
$sbContentType.Append($part1.ContentType)

$xmlFromZip = New-Object Chilkat.Xml

if ($sbContentType.Contains("gzip",$false) -eq $true) {
    # This is a gzip compressed file.
    $gzip = New-Object Chilkat.Gzip

    # in-place uncompress the data.
    # Note: The UncompressBd method was added in Chilkat v9.5.0.67
    $success = $gzip.UncompressBd($zipData)
    if ($success -ne $true) {
        $($gzip.LastErrorText)
        exit
    }

    $xmlFromZip.LoadXml($zipData.GetString("utf-8"))

}
else {
    # This is a zip archive.

    # Load the body into a Zip object.
    $zip = New-Object Chilkat.Zip
    $success = $zip.OpenBd($zipData)
    if ($success -ne $true) {
        $($zip.LastErrorText)
        exit
    }

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

    # The zip should contain a single XML file.
    if ($zip.NumEntries -ne 1) {
        $("Expected the .zip to have 1 entry.")
        $("NumEntries = " + $zip.NumEntries)
        $("Failed.")
        exit
    }

    $entry = $zip.GetEntryByIndex(0)

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

}

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

$("Success.")