Setting Response Headers in SuiteScript Server Scripts

The method for setting the value of an HTTP response header in SuiteScript allows developers to control header information sent by their applications. Understanding how to implement this functionality is crucial for enhancing interactivity and compliance with web standards.

Method Description

This method allows the setting of a response header's value, essential for providing additional information via HTTP responses. The usage of headers is common in web applications, helping to manage content negotiations and cache behaviors.

Supported Script Types

• Server scripts only.

Governance

• No governance limits apply.

Module

This functionality is part of the N/http Module.

Parent Object

This method is associated with the http.ServerResponse object.

Parameters

The method utilizes a single parameter — options, which is a JavaScript object containing the following attributes:

Errors

Be aware of the following potential errors when using this method:

• Error Code: SSS_INVALID_HEADER
  Message: One or more headers are not valid.
  Thrown If: The header name or value is invalid.

• Error Code: SSS_MISSING_REQD_ARGUMENT
  Message: Missing a required argument: {param name}.
  Thrown If: Either options.name or options.value were not specified.

Syntax

The following code sample illustrates how to set an HTTP response header:

// Set HTTP header
serverResponse.setHeader({
    name: 'Accept-Language',
    value: 'en-us',
});

This snippet demonstrates the syntax to invoke the method, which would be integrated into server-side scripts where the response is constructed.

Key Context

HTTP headers are crucial for transmitting additional information within requests and responses. They adhere to specific syntactical rules, such as not including underscores in custom header names. The headers not directly managed by application scripts include several restrictive elements typical in web protocols.

Related Topics

• http.ServerResponse
• HTTP Header Information
• N/http Module
• SuiteScript 2.x Modules

Important Note

Some HTTP headers cannot be set manually and will be ignored if specified. Notable blocked headers include Connection, Content-Length, and Host. When coding, always refer to the list of blocked headers to avoid unintentional issues in your applications.

Key Takeaways

• Use the serverResponse.setHeader() method to manipulate HTTP response headers.
• This method is only applicable within server scripts.
• Pay attention to mandatory parameter specifications to avoid errors.
• Certain HTTP headers cannot be configured, resulting in ignored values.

Source: This article is based on Oracle's official NetSuite documentation.