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.

local chilkat = require("chilkat")

local rest = chilkat.Rest.new()
local bTls = true
local bAutoReconnect = true
local success = rest:connect("example.com", 443, bTls, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- 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.
local bdResponse = chilkat.BinData.new()
success = rest:full_request_no_body_bd("GET", "/api/images/1", bdResponse)
if not success then
    print(rest.last_error_text)
    return
end

local bSaved = bdResponse:write_file("qa_output/image.png")
if not bSaved then
    print("Failed to save the response body.")
    return
end

print("Downloaded " .. bdResponse.num_bytes .. " bytes.")