Xbase++

Remove a Query Parameter from a REST Request

Demonstrates Rest.RemoveQueryParam, which removes all query parameters whose name matches the supplied value. Name matching is case-sensitive.

Background. Removing individual parameters is useful when reusing a Rest object for requests that share most, but not all, of their query parameters.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nBAutoReconnect
LOCAL cResponseText

nSuccess := 0

oRest := 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.
nBTls := 1
nBAutoReconnect := 1
nSuccess := oRest:Connect("example.com", 443, nBTls, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

oRest:AddQueryParam("q", "chilkat")
oRest:AddQueryParam("limit", "10")

//  Remove a query parameter by name.  Name matching is case-sensitive.
oRest:RemoveQueryParam("limit")

cResponseText := oRest:FullRequestNoBody("GET", "/api/search")
IF (oRest:LastMethodSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

? cResponseText

oRest:destroy()