NEnextbillion-ai
Geofence

Geofence Contains

Changed on
get/geofence/contain

Request

Query parameters

geofencesstring geofenceID_1,geofenceID_2,....
Example:geofences=80d1fa55-6287-4da0-93ac-2fc162d0a228,70d1fa55-1287-4da0-93ac-2fc162d0a228

A , separated list geofence IDs against which the locations will be searched. If not provided, then the 'locations' will be searched against all your existing geofences.

Maximum length of the string can be 256 characters.

locationsstring required
Example:13.25805884388484,77.91083661048299|13.25805884388484,77.91083661048299

Pipe (|) separated coordinates, in [latitude,longitude] format, of the locations to be searched against the geofences.

verbosestring
Example:verbose=true

When true, an array with detailed information of geofences is returned. When false, an array containing only the IDs of the geofences is returned.

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Response

OK

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.

Example response

{
  "data": {
    "result_list": [
      {
        "geofence_detail": {
          "ic_coordinates": "\"ic_coordinates\":13.258058,77.910836"
        }
      }
    ]
  }
}

Changes

  • 7ee76f0ff679Revision changes
    • warning

      added the new circle enum value to the //// response property for the response status

    • warning

      added the new isochrone enum value to the //// response property for the response status

    • warning

      added the new polygon enum value to the //// response property for the response status

    • info

      removed the circle enum value from the //// response property for the response status

    • info

      removed the isochrone enum value from the //// response property for the response status

    • info

      removed the polygon enum value from the //// response property for the response status

  • a800b73f11c1Revision changes
    • warning

      added the new circle enum value to the //// response property for the response status

    • warning

      added the new isochrone enum value to the //// response property for the response status

    • warning

      added the new polygon enum value to the //// response property for the response status

    • info

      removed the circle enum value from the //// response property for the response status

    • info

      removed the isochrone enum value from the //// response property for the response status

    • info

      removed the polygon enum value from the //// response property for the response status