Geofencing Extension API Developer's Guide

Search Proximity Request

Resource URI

/search/proximity.json

Resource Parameters

Parameter Type Mandatory Description
app_id string Y

Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.

app_code string Y

Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.

layer_ids list of integers Y

Comma separated list of the selected layer ids.

proximity string Y

Asset GPS position latitude and longitude in WGS84 degree, comma separated, and optionally a radius im meter. The radius defines how far to search around the asset position for geo fence geometries. Default raduis = 1,000 meter. For maximum values please refer to CLE's resource serviceconfiguration.json.

Multiple coordinate pairs can be passed as a semicolon separated list. For each of them the layer_ids list will be searched. If each coordinate pair shall be searched in a different set of layers, then layer_ids shall contain a semicolon separated list of (comma separated list of) layers.

attributes string N

Semicolon separated list of attribute names to be returned with the geometries. Default: Return all attributes. If all listed attributes are preceded with a minus, then all attributes except those are returned.

key_attributes string Y

Names of the attributes that identify each geometry. Comma separated. See Key Concepts for possibilities to use this parameter.

callback string N

Specifies the name of a user-defined function used to wrap the JSON response. Required for JSONP requests.

Default: No JSONP response wrapper

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.