RecipientCandidateAggregate Property
String representing the list of destination address candidates (if any).
Syntax
upsrates.getRecipientCandidateAggregate([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 getRecipientCandidateAggregate([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 setRecipientCandidateAggregate([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 destination address provided in the time-in-transit request (when the GetShippingTime method is called) is an invalid address, a list of potential candidates for the destination address will be returned in the server response. This is applicable for US only.
This destination address candidate list will be stored as a string in RecipientCandidateAggregate, formatted as XML.
To get the detailed information for each destination address candidate (city, state, zip code range), the UPSAddress class can be used. To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .
The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values.
This property is read-only.
Data Type
String