PowerShell

HTTP POST and Stream Response to File

See more REST Examples

Demonstrates how to send an HTTP POST and stream the response body directly to a file. PowerShell

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

$success = $false

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$rest = New-Object Chilkat.Rest

$url = New-Object Chilkat.Url
# This URL will emit a response that echos the query params (name and age)
$url.ParseUrl("https://www.chilkatsoft.com/readPost.asp")

# Connect to the web server
$bAutoReconnect = $true
$success = $rest.Connect($url.Host,$url.Port,$url.Ssl,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$rest.AddQueryParam("name","John")
$rest.AddQueryParam("age","33")

#  Send the HTTP POST.
$success = $rest.SendReqFormUrlEncoded("POST",$url.Path)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# Read the response header.
$responseStatusCode = $rest.ReadResponseHeader()
if ($responseStatusCode -lt 0) {
    $($rest.LastErrorText)
    exit
}

$("Response status code = " + $responseStatusCode)

# We expect a 200 response status if the file data is coming.
# Otherwise, we'll get a string response body with an error message(or no response body).
if ($responseStatusCode -eq 200) {

    $bodyStream = New-Object Chilkat.Stream

    # The stream's sink will be a file.
    $bodyStream.SinkFile = "qa_output/out.txt"

    # Read the response body to the stream.  Given that we've
    # set the stream's sink to a file, it will stream directly
    # to the file.
    $success = $rest.ReadRespBodyStream($bodyStream,$true)
    if ($success -ne $true) {
        $($rest.LastErrorText)
        exit
    }

    $("Successfully streamed the response to a file.")

}
else {
    $errResponse = $rest.ReadRespBodyString()
    if ($rest.LastMethodSuccess -ne $true) {
        $($rest.LastErrorText)
    }
    else {
        $($errResponse)
    }

}