Add a Query Parameter to a REST Request

See more REST Examples

Demonstrates Rest.AddQueryParam, which adds or replaces a query-string parameter. The 1st argument is the parameter name and the 2nd is its value; Chilkat URL-encodes both as needed.

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

    ;  Add query-string parameters.  The 1st argument is the parameter name and the 2nd is its value.
    ;  Chilkat automatically URL-encodes names and values as needed.
    CkRest::ckAddQueryParam(rest,"q","chilkat rest")
    CkRest::ckAddQueryParam(rest,"limit","10")

    ;  For a GET request the parameters are appended to the URL query string.
    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