PowerShell

Read the REST Response Header and Status Code

Demonstrates Rest.ReadResponseHeader, which reads the HTTP response status line and header fields after a staged send. The returned integer is the HTTP status code, or -1 if no response was received.

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
}

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

#  Read the HTTP response status line and header fields.  The returned integer is the HTTP status
#  code (such as 200, 404, or 500), or -1 if no response was received.
$statusCode = $rest.ReadResponseHeader()
if ($statusCode -lt 0) {
    $($rest.LastErrorText)
    exit
}

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