Sign in
project

Resolve Address

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 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

Changed in 3 of the 30 revisions of this API.35

  • bb508e9351743See the full diff
    • ▲

      the request property became required

      request-property-became-required

    • ▲

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

      request-property-list-of-types-narrowed

    • ▲

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

      request-property-pattern-added

  • 95495ef535bc4See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ab171f3fcfbe1See the full diff
    • ○

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

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog