VBScript

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

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

set rest = 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.
bTls = 1
bAutoReconnect = 1
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = 0) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
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")

responseText = rest.FullRequestNoBody("GET","/api/data")
If (rest.LastMethodSuccess = 0) Then
    outFile.WriteLine(rest.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(responseText)

outFile.Close