Get Header Values from ServerResponse in SuiteScript

TL;DR Opening

This article explains how to retrieve HTTP header values using the ServerResponse object in SuiteScript. By utilizing the getHeader method, developers can easily access the headers from server responses, improving data management in their applications.

Method Description

The getHeader method returns the value or values of a specified response header. When multiple values are associated with the same header name, they are returned as an array, providing flexibility in handling various header formats.

Returns

• Type: string | string[]

Supported Script Types

• Server scripts

For more information, refer to the SuiteScript 2.x Script Types.

Governance

• None applicable.

Parameters

The options parameter is a JavaScript object that contains the following key:

Errors

The following error may be thrown if a required argument is missing:

• Error Code: SSS_MISSING_REQD_ARGUMENT
  • Message: Missing a required argument: {param name}
  • Thrown If: The options.name parameter is not specified.

Syntax

Here’s how to use the getHeader method:

1// Sample code snippet to retrieve a header
2... 
3serverResponse.getHeader({
4    name: 'Accept-Language'
5});
6... 

Note: The above code snippet is illustrative. For functional examples, see the N/http Module Script Samples.

Related Topics

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

Key Takeaways

• The getHeader method enables developers to access HTTP header values from a server response easily.
• It supports multiple values for the same header, returning them as an array.
• Proper error handling ensures that required parameters are provided, enhancing script robustness.
• This functionality is available starting from SuiteScript version 2015.2.