Xbase++

Add a Request Header to a REST Request

Demonstrates Rest.AddHeader, which adds an HTTP request header field. The 1st argument is the field name and the 2nd is the value. Adding a header whose name already exists replaces the previous value.

Background. Request headers configured with AddHeader are applied to subsequent requests sent through the object, such as Accept, Content-Type, or custom application headers.

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

//  Add request header fields.  The 1st argument is the field name and the 2nd is the value.
//  Adding a header with a name that already exists replaces the previous value.
oRest:AddHeader("Accept", "application/json")
oRest:AddHeader("X-Custom-Header", "example-value")

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

? cResponseText

oRest:destroy()