PowerShell

Send a Staged Form-URL-Encoded REST Request

Demonstrates Rest.SendReqFormUrlEncoded, which sends an application/x-www-form-urlencoded request whose body is built from the query parameters added to the object.

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 form body is built from the query parameters added to the object.
$rest.AddQueryParam("username","alice")
$rest.AddQueryParam("action","login")

#  Send the application/x-www-form-urlencoded request.
$success = $rest.SendReqFormUrlEncoded("POST","/api/login")
if ($success -eq $false) {
    $($rest.LastErrorText)
    exit
}

#  After sending, read the response status line and header fields.  The return value is the HTTP
#  status code, or -1 if no response was received.
$statusCode = $rest.ReadResponseHeader()
if ($statusCode -lt 0) {
    $($rest.LastErrorText)
    exit
}

$("Response status code: " + $statusCode)

#  Read the response body as text.
$responseBody = $rest.ReadRespBodyString()
if ($rest.LastMethodSuccess -eq $false) {
    $($rest.LastErrorText)
    exit
}

$($responseBody)