Using the ServerResponse Write Method in SuiteScript 2.x

The ServerResponse write method is a key tool in SuiteScript that allows developers to send text, XML, or HTML back through the server response. This method is particularly useful in server scripts where formatted output is necessary for user interactions or API responses.

Method Description

This method takes only strings as input. If you need to send a file, you should use the ServerResponse.writeFile(options) method instead.

Returns

The method does not return any value (void).

Supported Script Types

• Server scripts

Governance

There are no governance limits associated with this method, making it flexible for frequent use.

Module

This method is part of the N/http Module, which handles HTTP functions in SuiteScript.

Parent Object

The write method belongs to the http.ServerResponse object.

Parameters

The options parameter is required and must be a JavaScript object containing the following:

Errors

Developers should account for the following errors when using this method:

• Error Code: SSS_MISSING_REQD_ARGUMENT

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

• Error Code: WRONG_PARAMETER_TYPE

  • Message: {param name}
  • Thrown If: The value input for options.output is not a string.

Syntax Example

Here’s a simple code example demonstrating how to use the write method:

1// Add additional code 
2...
3serverResponse.write({
4    output: 'Hello World'
5});
6...
7// Add additional code

This code snippet illustrates the basic syntax without extending into a full functional application. For more complete examples, refer to the N/http Module Script Samples.

Related Topics

• http.ServerResponse
• N/http Module
• SuiteScript 2.x Modules

Key Takeaways

• The write method outputs strings in SuiteScript responses.
• It can only accept string input and does not handle files directly.
• Be mindful of common errors, such as missing parameters or incorrect types.
• Refer to the N/http Module for comprehensive usage examples.