Add HTTP Response Headers in SuiteScript for NetSuite

TL;DR Opening

Adding HTTP response headers in SuiteScript allows developers to customize server responses by transmitting additional information. This feature is essential for ensuring seamless application behavior and improving HTTP communication.

Method Description

The addHeader method is employed to add a header to the HTTP response. If the header has been previously set, the method appends another line for the same header. For example:

{Vary: ['Accept-Language', 'Accept-Encoding']}

It’s crucial to note that the addHeader method does not return any value and is utilized in server scripts.

Supported Script Types

• Server scripts: Utilize this method while programming in server contexts, especially while handling HTTP responses.

Governance

This method does not impose any governance limits, which means it can be executed without restrictions on usage counts.

Parent Object

The addHeader method belongs to the http.ServerResponse object, which is part of the N/http module in SuiteScript.

Parameters

The options parameter is a JavaScript object that includes the following:

Errors

It's important to handle potential errors properly. Below are the specific error codes:

Syntax

The following code snippet offers a basic illustration of the syntax:

1// Add additional code
2...
3serverResponse.addHeader({
4    name: 'Accept-Language',
5    value: 'en-us',
6});
7...
8// Add additional code

This code sample serves as a template for implementing the addHeader method.

Related Topics

For further insights, review related topics:

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

Key Takeaways

• SuiteScript allows adding custom HTTP headers through the addHeader method.
• The method operates in server scripts and does not enforce governance limits.
• Essential parameters include header name and value, both of which are mandatory.
• Always handle potential errors like SSS_INVALID_HEADER and SSS_MISSING_REQD_ARGUMENT properly.