Read the REST Response Body into BinData

See more REST Examples

Demonstrates Rest.ReadRespBd, which reads the response body as raw bytes into a BinData, replacing its previous contents.

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.

success = rest:send_req_no_body("GET", "/api/images/1")
if not success then
    print(rest.last_error_text)
    return
end

local statusCode = rest:read_response_header()
if statusCode < 0 then
    print(rest.last_error_text)
    return
end

-- Check for the expected success status code.  If the response is not 200, the body is likely
-- error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
-- read the body as text, report it, and return.
if statusCode ~= 200 then
    local sbError = chilkat.StringBuilder.new()
    success = rest:read_resp_sb(sbError)
    if not success then
        print(rest.last_error_text)
        return
    end

    print("Request failed with status code " .. statusCode)
    print(sbError:get_as_string())
    return
end

-- The status code is 200.  Read the response body as raw bytes into a BinData.
local bdResponse = chilkat.BinData.new()
success = rest:read_resp_bd(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("Received " .. bdResponse.num_bytes .. " bytes.")