capIdsGetByAddr

Returns records that have the same property address as the current record, as an array of capId (CapIDModel) objects.

Version

1.4

Parameters

None

Returns

If the current record has no property address, returns false.

Notes

The function matches addresses based on these fields:

• House Nbr Start

• Street Direction

• Street Name

• Street Suffix

• Zip

You can use this function with all events except ApplicationSubmitBefore. The records returned include the current record. If the current record has more than one property address, the function uses the first address to match.

To find the number of records returned, store the return value to a variable and use the length property to find the number of records in the array.

Example

capArray = capIdsGetByAddr(); logDebug("Number of CAPs: " + capArray.length);