Lianja

Add a Path Substitution Parameter to a REST Request

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 Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

loRest = createobject("CkRest")

//  Connect to the REST server.  The 3rd argument enables TLS (use .T. for HTTPS on port 443),
//  and the 4th enables automatic reconnection if the connection is dropped between requests.
llBTls = .T.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("example.com",443,llBTls,llBAutoReconnect)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

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

//  The placeholders in the path are replaced before the request is sent.
lcResponseText = loRest.FullRequestNoBody("GET","/users/{userId}/orders/{orderId}")
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

? lcResponseText


release loRest