B4X

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

Download Chilkat for B4X

B4X

Dim success As Boolean = False

Dim rest As ChilkatRest
rest.Initialize("rest")

'  Connect to the REST server.  The 3rd argument enables TLS (use True for HTTPS on port 443),
'  and the 4th enables automatic reconnection if the connection is dropped between requests.
Dim bTls As Boolean = True
Dim bAutoReconnect As Boolean = True
success = rest.Connect("example.com", 443, bTls, bAutoReconnect)
If success = False Then
    Log(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.
rest.AddHeader("Accept", "application/json")
rest.AddHeader("X-Custom-Header", "example-value")

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

Log(responseText)