SenderCandidateAggregate Property

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

Syntax

[VB.NET]
Public ReadOnlyProperty SenderCandidateAggregate As String

[C#]
public string SenderCandidateAggregate {get;}

Remarks

If the origin 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 origin address will be returned in the server response. This is applicable for US only.

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

To get the detailed information for each origin address candidate (city, state, zip code range), the UPSAddress component can be used. To read an address, set the Aggregate property of an UPSAddress component 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.

Default Value

""