Add a Path Substitution Parameter to a REST Request

See more REST Examples

Demonstrates Rest.AddPathParam, which adds or replaces a path-substitution parameter. Before a request is sent, each occurrence of the name in the URI path is replaced with its value.

load ./chilkat.dll

set success 0

set rest [new_CkRest]

#  Connect to the REST server.  The 3rd argument enables TLS (use 1 for HTTPS on port 443),
#  and the 4th enables automatic reconnection if the connection is dropped between requests.
set bTls 1
set bAutoReconnect 1
set success [CkRest_Connect $rest "example.com" 443 $bTls $bAutoReconnect]
if {$success == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

#  Add path-substitution parameters.  Before a request is sent, each occurrence of the name in the
#  URI path is replaced with the value.  This keeps the path template readable.
CkRest_AddPathParam $rest "{userId}" "12345"
CkRest_AddPathParam $rest "{orderId}" "98765"

#  The placeholders in the path are replaced before the request is sent.
set responseText [CkRest_fullRequestNoBody $rest "GET" "/users/{userId}/orders/{orderId}"]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

puts "$responseText"

delete_CkRest $rest