Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnBAutoReconnect
LOCAL lcResponseText

lnSuccess = 0

loRest = CreateObject('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.
lnBTls = 1
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("example.com",443,lnBTls,lnBAutoReconnect)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
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 = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

? lcResponseText

RELEASE loRest