Sample code for 30+ languages & platforms
Xojo Plugin

Add a Request Header to a REST Request

See more REST Examples

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 Xojo Plugin Downloads

Xojo Plugin
Dim success As Boolean
success = False

Dim rest As New 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.
Dim bTls As Boolean
bTls = True
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

//  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.
success = rest.AddHeader("Accept","application/json")
success = rest.AddHeader("X-Custom-Header","example-value")

Dim responseText As String
responseText = rest.FullRequestNoBody("GET","/api/data")
If (rest.LastMethodSuccess = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

System.DebugLog(responseText)