PowerShell

Read the REST Response Body into BinData

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.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

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.

$success = $rest.SendReqNoBody("GET","/api/images/1")
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

$statusCode = $rest.ReadResponseHeader()
if ($statusCode -lt 0) {
    $($rest.LastErrorText)
    exit
}

#  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 -ne 200) {
    $sbError = New-Object Chilkat.StringBuilder
    $success = $rest.ReadRespSb($sbError)
    if ($success -eq $false) {
        $($rest.LastErrorText)
        exit
    }

    $("Request failed with status code " + $statusCode)
    $($sbError.GetAsString())
    exit
}

#  The status code is 200.  Read the response body as raw bytes into a BinData.
$bdResponse = New-Object Chilkat.BinData
$success = $rest.ReadRespBd($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
}

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