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.

Dim success As Boolean = False

Dim rest As ChilkatRest
rest.Initialize("rest")

'  Connect to the REST server.  The 3rd argument enables TLS (use True for HTTPS on port 443),
'  and the 4th enables automatic reconnection if the connection is dropped between requests.
Dim bTls As Boolean = True
Dim bAutoReconnect As Boolean = True
success = rest.Connect("example.com", 443, bTls, bAutoReconnect)
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


'  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.
rest.AddPathParam("{userId}", "12345")
rest.AddPathParam("{orderId}", "98765")

'  The placeholders in the path are replaced before the request is sent.
Dim responseText As String = rest.FullRequestNoBody("GET", "/users/{userId}/orders/{orderId}")
If rest.LastMethodSuccess = False Then
    Log(rest.LastErrorText)
    Return
End If

Log(responseText)