AddParameter Method

Adds a parameter to the query string.

Syntax

shiprequest.addParameter(paramName, paramValue, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method is used to add a parameter name and value to the query string to be sent to the server. Note that any parameters added with this method will be URL encoded automatically.

If ContentType is set to "application/x-www-form-urlencoded", any parameters added with this method will be sent to the server as form data in the body of the request, instead of as query string parameters.