Xbase++

Remove a Request Header from a REST Request

Demonstrates Rest.RemoveHeader, which removes all request headers matching the supplied name.

Background. Removing a header is useful when reusing a Rest object across requests that require different header sets.

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:AddHeader("Accept", "application/json")
oRest:AddHeader("X-Custom-Header", "example-value")

//  Remove a previously added request header by name.
oRest:RemoveHeader("X-Custom-Header")

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

? cResponseText

oRest:destroy()