Lianja

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 Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

loRest = createobject("CkRest")

//  Connect to the REST server.  The 3rd argument enables TLS (use .T. for HTTPS on port 443),
//  and the 4th enables automatic reconnection if the connection is dropped between requests.
llBTls = .T.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("example.com",443,llBTls,llBAutoReconnect)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    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.
loRest.AddHeader("Accept","application/json")
loRest.AddHeader("X-Custom-Header","example-value")

lcResponseText = loRest.FullRequestNoBody("GET","/api/data")
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

? lcResponseText


release loRest