Addresses

Which Search Addresses endpoint to use

Use the Search Addresses endpoint that is specific to the type of query object criteria.

The Accela GIS API provides separate Search Addresses resource endpoints for each type of query object. Although they all return the same address resource object model, the separate endpoints are provided for efficiency and performance purposes. If an application wishes to query addresses that are associated with a specific parcel, it is more efficient to use Search Addresses by Parcel instead of Search Addresses by Multiple with a parcel query object. Similarly, to search addresses based on address fields, use Search Addresses by Address; to search addresses associated with a specific owner, use Search Addresses by Owner. Search Addresses by Multiple performs combinations of spatial queries per address, parcel, and owner object specified in the request body and can execute longer than the other type-specific resource endpoints.

Configuration

• The Search Addresses API's require that the XAPO data source fields are mapped to Civic Platform fields. The XAPO field mapping is defined on the GIS Admin Site > {agency} > XAPO Configuration page.

• A GIS agency administrator can set the XAPO configuration setting Feature Count Limit which defines the maximum number of returned results. The feature count limit is defined on the GIS Admin Site > {agency} > XAPO Configuration page. The default is 200. If the search results are greater than the feature count limit, the API returns an error indicating the exceeded feature count limit; in this case, the API caller should re-submit the query with a narrower criteria or set the maxRows page setting to a number less than the feature count limit.