Capture Find: Filters
Details of the filters supported by Capture Find
Using Filters as part of a Capture Find call you can include or exclude certain type of addresses or locations from the address matches presented back to the end user. All Filters are currently operating on the basis of an exact match. Multiple filters can be provided in the same request.
&Filters=<Fieldname>:<Text> - this is an IS filter and will limit matches to the subset where this field value is as specified
&Filters=!<Fieldname>:<Text> - this is an ISN’T filter and will exclude any matches where this field value is as specified
Example
This will return matches that are in Nottingham, UK and exclude addresses with NG11 7EP postcode:
Available filters
The following filters are supported:
| Filter | Description |
|---|---|
| Postcode | Postal code / Postcode / ZIP Code. Values can be specified regardless of casing or spaces. In the US it is possible to specify ZIP Code without the Zip+4 part and the results will include all records with the primary ZIP Code specified. |
| Locality | The most common population centre within a country (i.e. USA City, Canadian Municipality). |
| DependentLocality | A smaller population centre, dependent on the contents of the Locality field (i.e. District). |
| Thoroughfare | The name of the street or thoroughfare. |
| OrganisationName | The name of the company listed at this address. |
| Language | The three character alpha country code as defined by the ISO 639-2/B specification. |
| AdministrativeArea (US addresses only) | The most common administrative district within a country (i.e. US State). |
| SubAdministrativeArea (US addresses only) | The smallest administrative region within a country (i.e. US County). |
| Attributes.CommercialResidential (US addresses only) | Address type. Allowed values are “Commercial” and “Residential”. |
| Attributes.HasSubpremises (US addresses only) | In the US, some addresses belong to a building that has a number of sub premises in it, (e.g. apartments or suites). By default, Capture will return an address of the building and a container with sub premises listed inside of it. You can exclude those building addresses where further sub premises exist by specifying a filter of HasSubpremises = NO. Allowed values are “YES” and “NO”. |
| HomeNation (UK addresses only) | This filter will restrict the results to addresses from the specified country within the UK. You can specify multiple values, and also invert the meaning to exclude selected countries (e.g. &Filters=!HomeNation:Northern Ireland ) Allowed values are “England”, “Scotland”, “Wales”, “Northern Ireland”, “Channel Islands”, “Isle of Man”. |