Geofencing Extension API Developer's Guide

Reading a Geofencing Extension API Response

The Geofencing Extension API search resource responds with the following structure.

Response for the Search Proximity Resource

The resource search/proximity.json provides a response that includes the following components:
  • An issues object that lists all the issues that the service encountered while processing the request. Your application should only use the response content if this list is empty.
  • A geometries object that lists the fence geometries that contain the asset's position or overlap the search radius around the asset's position. Only one result geometry is returned for each distinct value of the key_attribute specified. This means that if your application submits a geofence geometry comprising of multiple faces or separate top level rings, they are treated as one geometry and only one distance that is the closest line of all its rings is returned.
  • A responseCode containing the HTTP response code and response text.
  • An errorId that can be passed on to Technical Customer Support for context, if errors occur during processing.
  • Metainformation about the processing of the request, as captured in the warnings and onError objects.
Example response structure for search/proximity.json resource:
{
  issues :
    [
      {
        message : "...",
        code : ...
      },
      ...
    ],
  warnings :
    [
      "...",
      ...
    ],
  error_id : "...",
  response_code : "...",
  geometries : 
    [
      {
        layerId : "...",
        distance : ...,
        nearestLat : ...,
        nearestLon : ...,
        attributes :
          {
            <attribute name 1> : "...",
            <attribute name 2> : "...",
            ...
          },
        geometry : "..."
      },
      ...
    ],
  onError : ...
}

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.