MatchResidentialStatus Property

Residential status of an address candidate in the list of matches (if any).

Syntax

 upsaddress.getMatchResidentialStatus(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 getMatchResidentialStatus([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 setMatchResidentialStatus([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

Residential status of an address candidate in the list of matches (if any). Possible returned values are:

• UNDETERMINED
• BUSINESS
• RESIDENTIAL
• INSUFFICIENT_DATA
• UNAVAILABLE
• UNKNOWN
• NOT_APPLICABLE_TO_COUNTRY

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