Remove a Query Parameter from a REST Request

See more REST Examples

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

IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    success.i = 0

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  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.
    bTls.i = 1
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"example.com",443,bTls,bAutoReconnect)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    CkRest::ckAddQueryParam(rest,"q","chilkat")
    CkRest::ckAddQueryParam(rest,"limit","10")

    ;  Remove a query parameter by name.  Name matching is case-sensitive.
    CkRest::ckRemoveQueryParam(rest,"limit")

    responseText.s = CkRest::ckFullRequestNoBody(rest,"GET","/api/search")
    If CkRest::ckLastMethodSuccess(rest) = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    Debug responseText


    CkRest::ckDispose(rest)


    ProcedureReturn
EndProcedure