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.

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BTls
integer li_BAutoReconnect
string ls_ResponseText

li_Success = 0

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  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.
li_BTls = 1
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("example.com",443,li_BTls,li_BAutoReconnect)
if li_Success = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    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.
loo_Rest.AddHeader("Accept","application/json")
loo_Rest.AddHeader("X-Custom-Header","example-value")

ls_ResponseText = loo_Rest.FullRequestNoBody("GET","/api/data")
if loo_Rest.LastMethodSuccess = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

Write-Debug ls_ResponseText


destroy loo_Rest