Tcl

Examine HTTP Response Status Code and Text

See more REST Examples

Demonstrates how to examine the HTTP response status code and text when using the REST object. Tcl

load ./chilkat.dll

set success 0

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

set rest [new_CkRest]

# We're going to check https://authenticationtest.com/HTTPAuth/
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "authenticationtest.com" $port $bTls $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

# Send a GET request
set responseText [CkRest_fullRequestNoBody $rest "GET" "/HTTPAuth/"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

# The start line of an HTTP response, called the status line, contains the following information:
# 
#     The protocol version, usually HTTP/1.1.
#     A status code, indicating success or failure of the request. Common status codes are 200, 404, or 302
#     A status text. A brief, purely informational, textual description of the status code to help a human understand the HTTP message.
# 
# A typical status line looks like: HTTP/1.1 404 Not Found.

# The ResponseStatusCode property contains the integer response code:
puts "Response status code = [CkRest_get_ResponseStatusCode $rest]"

# The ResponseStatusText property contains the text (if any) that follows the status code on the status line.
puts "Response status text = [CkRest_responseStatusText $rest]"

# In this case, the sample output is:
# 
# Response status code = 401
# Response status text = Unauthorized

delete_CkRest $rest