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 : ...
}