MatchQuality Property

Quality factor an address candidate in the list of matches (if any).

Syntax

 upsaddress.getMatchQuality(index, [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 getMatchQuality([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 setMatchQuality([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

Quality factor an address candidate in the list of matches (if any).

Each address is returned with an assigned quality value that indicates how closely the address candidate matches the search criteria. This is used to rate the submitted address. If the MatchQuality is too low, the class returns the "Address Not Validated" message.

In FedEx, possible values range from 0 to 100, with 100 being the highest and zero indicating failure.

In UPS, this is applicable for a non street-level address validation and/or classification (i.e., when the Address1 is not set in the request). Possible values are:

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String