Error Handling and HTTP Response Headers in SuiteScript

The handling of errors and HTTP response headers in SuiteScript is essential for developers working with both client and server scripts. This article covers key error codes and the implications of HTTP headers.

How Do HTTP Response Headers Work?

HTTP response headers deliver additional information when making HTTP requests. Each header consists of a case-insensitive name followed by a colon and its corresponding value.

Types of HTTP Response Headers

For client scripts, response header values can be a list of strings due to the ability to handle multiple headers with the same name. In server SuiteScript, however, each header value is a single string, preserving only the first instance if multiple headers share the same name.

What Are Common Error Codes?

READ_ONLY_PROPERTY

• Thrown If: You attempted to edit a read-only property.

Code Sample: Accessing Response Headers

The following code snippet demonstrates accessing response headers, showcasing both client and server SuiteScript.

1var response = https.get({
2    url: 'https://www.testwebsite.com'
3});
4log.debug({
5    title: 'Client Response Header',
6    details: response.headers
7});

In this example, the headers are logged for debugging purposes. For instance, while a client script can access multiple values for a header:

response.headers["cache-control"]
// Output: ["no-cache", "no-store"]

A server script can only retrieve the first value:

response.headers["cache-control"]
// Output: "no-cache"

Best Practices for Handling HTTP Headers

• Case Sensitivity: HTTP headers are defined as case-insensitive. It is recommended to retrieve them in lower-case, e.g., response.headers["content-type"].
• Header Compatibility: Each header may be represented in multiple cases for compatibility. Examples include:
  • `