Aggregate Property

String representing the list of address candidates (if any).

Syntax

 upsaddress.getAggregate([callback])
 upsaddress.setAggregate( aggregate, [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 getAggregate([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 setAggregate([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

If the address provided in the request is an invalid or ambiguous address, a list of potential candidates will be returned in the server response.

This address candidate list will be stored as a string in Aggregate, formatted as XML.

This can be used with the UPSRates class to get the detailed information for each origin/destination address candidate (city, state, zip code range) by setting the Aggregate to UPSRates's SenderCandidateAggregate or RecipientCandidateAggregate after a call to GetShippingTime.

Data Type

String