PowerShell

Send a Staged REST Request with a Text Body

Demonstrates Rest.SendReqStringBody, which sends a request whose text body (such as JSON) is supplied directly, then reads the response in separate steps.

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
}

$rest.AddHeader("Content-Type","application/json")

#  Send a request whose text body (such as JSON) is supplied directly.
$jsonBody = "{ `"name`": `"example`" }"
$success = $rest.SendReqStringBody("POST","/api/items",$jsonBody)
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)