Xojo Plugin
Xojo Plugin
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.
Background. Path parameters keep a URI path template readable—placeholders such as
{userId} are substituted with concrete values just before the request is sent.Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
Dim rest As New Chilkat.Rest
// 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.
Dim bTls As Boolean
bTls = True
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = False) Then
System.DebugLog(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.
success = rest.AddPathParam("{userId}","12345")
success = rest.AddPathParam("{orderId}","98765")
// The placeholders in the path are replaced before the request is sent.
Dim responseText As String
responseText = rest.FullRequestNoBody("GET","/users/{userId}/orders/{orderId}")
If (rest.LastMethodSuccess = False) Then
System.DebugLog(rest.LastErrorText)
Return
End If
System.DebugLog(responseText)