Notes Property

Message returned when multiple addresses found.

Syntax

 uspsaddress.getNotes([callback])

Default Value

""

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 the getNotes([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setNotes([callback]) 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 property is returned only when the address entered results in multiple locations being found by the USPS USPSServer, but a default address exists.

In this case, the text of the message will read: "Default address: The address you entered was found, but more information is needed (such as an apartment, suite or box number) to match to a specific address." Other messages may also be returned under different circumstances.

This property is read-only.

Data Type

String