Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnBAutoReconnect
LOCAL lcResponseText

lnSuccess = 0

loRest = 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.
lnBTls = 1
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("example.com",443,lnBTls,lnBAutoReconnect)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
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.
loRest.AddHeader("Accept","application/json")
loRest.AddHeader("X-Custom-Header","example-value")

lcResponseText = loRest.FullRequestNoBody("GET","/api/data")
IF (loRest.LastMethodSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

? lcResponseText

RELEASE loRest