MAmaia-analytics
project

Resolve Address

Changed on

Resolve free text to ranked, label-hydrated candidates for address entry.

Pre-project: bounded to request.county_fips, the county picked first; a county the workspace may not read is 404. A read failure surfaces as 503 rather than the raw error, which can carry a sandbox connection URI.

post/api/v1/project/address/resolve

Request

  • Base URL
    https://api.maia-analytics.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maia-analytics.com/api/v1/project/address/resolve
  • Auth
    HTTP bearer

Request body

querystring required
county_fipsstring required
geocoder_policy'internal_only' | 'external_fallback'

Whether a pre-project address lookup can use the external geocoder.

Response

Successful Response

outcome'matched' | 'not_in_dataset' | 'not_loaded_county' required

Result classification. not_loaded_county (a real reference in a county this workspace hasn't loaded) is reserved for the forward-geocoder path, the only place able to confirm a reference is real and name its county.

geocoder_locatedboolean

The external geocoder placed the address in a loaded county, but no held feature is there.

Changes

  • bb508e935174Revision changes
    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      added the pattern ^\d{5}$ to the request property

  • 95495ef535bcRevision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status