Sample code for 30+ languages & platforms
PowerShell

Download a Binary REST Response into BinData

See more REST Examples

Demonstrates Rest.FullRequestNoBodyBd, which sends a request with no body and stores the binary response body in a BinData.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. This method is appropriate when the response is binary, such as an image or file download, allowing the received bytes to be saved or processed directly.

Chilkat PowerShell Downloads

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

$success = $false

$rest = New-Object Chilkat.Rest
$bTls = $true
$bAutoReconnect = $true
$success = $rest.Connect("example.com",443,$bTls,$bAutoReconnect)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

#  The file paths are relative to the application's current working directory.  Absolute paths
#  may also be used.  Supply the paths appropriate to your own environment.

#  FullRequestNoBodyBd sends a request with no body and stores the binary response body in a
#  BinData.  This is appropriate when the response is binary, such as an image or file download.
$bdResponse = New-Object Chilkat.BinData
$success = $rest.FullRequestNoBodyBd("GET","/api/images/1",$bdResponse)
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

$bSaved = $bdResponse.WriteFile("qa_output/image.png")
if ($bSaved -ne $true) {
    $("Failed to save the response body.")
    exit
}

$("Downloaded " + $bdResponse.NumBytes + " bytes.")