geofence.list

TR50 Request

{
  "cmd": {
    "command": "geofence.list"
  }
}

Request Parameters


Name	Type	Description
offset	Integer	The starting list offset, used for pagination. Defaults to 0 if not specified.
limit	Integer	Limit the number of results returned. Defaults to the configured maximum limit.
tags	Array	If specified, the command will only return results that possess all of these tags.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.

{
  "cmd": {
    "success": true,
    "params": {
      "count": 3,
      "result": [
        {
          "key": "boca",
          "name": "Test Triangle",
          "points": [
            [
              26.409196,
              -80.171016
            ],
            [
              26.420419,
              -80.06596
            ],
            [
              26.321681,
              -80.074886
            ]
          ],
          "createdBy": "admin@example.com",
          "createdOn": "2014-03-24T15:52:17.276-04:00",
          "updatedBy": "admin@example.com",
          "updatedOn": "2014-03-24T17:19:54.224-04:00"
        },
        {
          "key": "ils",
          "name": "ILS Circle",
          "radius": 0.8565,
          "points": [
            [
              26.394915,
              -80.112575
            ]
          ],
          "createdBy": "admin@example.com",
          "createdOn": "2014-03-25T11:03:02.318-04:00",
          "updatedBy": "admin@example.com",
          "updatedOn": "2014-03-25T15:43:25.573-04:00"
        },
        {
          "key": "fau",
          "name": "FAU Circle",
          "radius": 2.58,
          "points": [
            [
              26.373805,
              -80.101833
            ]
          ],
          "createdBy": "admin@example.com",
          "createdOn": "2014-03-25T15:47:49.514-04:00",
          "updatedBy": "admin@example.com",
          "updatedOn": "2014-03-25T16:01:00.157-04:00"
        }
      ]
    }
  }
}

Response Parameters


Name	Type	Description
result	Array	An array consisting of result objects.

Result Object


Name	Type	Description
key	String	The key of the geofence.
name	String	The name of the geofence.
radius	Float	The radius of a radial geofence, in kilometers.
points	Array	Contains either the center of a radial geofence or the points defining a polygonal geofence.
tags	Array	The tags associated with the geofence.
createdBy	String	The creator of the geofence.
createdOn	String	The creation timestamp of the geofence.
updatedBy	String	The updater of the geofence.
updatedOn	String	The update timestamp of the geofence.