ServerResponse Header Setting in SuiteScript

Setting HTTP headers using ServerResponse.setHeader in SuiteScript is essential for customizing server responses effectively. This method allows you to define headers that can specify language preferences, control caching, and more.

How to Set HTTP Headers with ServerResponse

The ServerResponse.setHeader(options) method in SuiteScript lets you assign the value of a response header. This is useful in server scripts to manage client-server communication effectively.

Supported Script Types

• Compatible with server scripts

Parameters Required

• options.name: This is a required string that represents the name of the header (e.g., 'Accept-Language').
• options.value: This is a required string that contains the header value you wish to set (e.g., 'en-us').

Error Codes

• SSS_INVALID_HEADER: Thrown when the header name or value is invalid.
• SSS_MISSING_REQD_ARGUMENT: Thrown if options.name or options.value is omitted.

Example Usage

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

Note: Substitute the 'Accept-Language' and 'en-us' with your desired header name and value.

Related Topics

For more details, refer to the [N/http Module], [http.ServerResponse], and explore HTTP header information and various SuiteScript 2.x concepts.

Who This Affects

This information is particularly relevant for:

• NetSuite Administrators
• Developers working with SuiteScript

Key Takeaways

• Easily set and manage HTTP headers in server scripts using ServerResponse.setHeader.
• Ensure to provide both header name and value to avoid errors.
• Features are available since SuiteScript version 2015.2.