{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/geofence/view.json","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"name","type":"string","default":"","desc":"Name of the geofence","required":false,"in":"query","ref":"","_id":"56308d30c3a8150d00fb790a"},{"name":"groupName","type":"string","default":"","desc":"Name of the group associated with the geofence","required":false,"in":"query","ref":"","_id":"56308d30c3a8150d00fb7909"},{"name":"page","type":"int","default":"1","desc":"Page number of the paginated result","required":false,"in":"query","ref":"","_id":"56308d30c3a8150d00fb7908"}],"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"geofenceResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Dec-07-2016, 06:09 AM UTC\",\n      \"currentPage\":1,\n      \"totalPages\":1,\n      \"geofences\":[  \n         {  \n            \"fenceId\":\"878fd158-b610-11e6-b51c-4b450d013ecf\",\n            \"name\":\"Sam's Office\",\n            \"createdAt\":\"Nov-29-2016, 08:47 AM\",\n            \"fenceType\":\"Circular\",\n            \"radius\":5.509985,\n            \"radiusUnit\":\"miles\",\n            \"geometry\":null,\n            \"address\":\"3415 Simpson Ferry Rd, Camp Hill, PA 17011, USA\",\n            \"latitude\":40.2260845,\n            \"longitude\":-76.9361986,\n            \"alertType\":\"BOTH\",\n            \"email\":[  \n               \"johnsam:::at:::azuga.com\"\n            ],\n            \"color\":\"#15eb15\",\n            \"ccAddress\":\"[email protected]\",\n            \"groupNames\":[  \n               \"Default Group\"\n            ],\n            \"mode\":0,\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null\n         }\n      ]\n   }\n}","name":""}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-geofences","excerpt":"This API provides you with information about all active geofences present in your account.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/geofence/view.json?groupName=WestCoast&USA-1&USA-4\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"code\",\n    \"0-1\": \"API Status Code\",\n    \"1-0\": \"message\",\n    \"1-1\": \"API Message\",\n    \"2-0\": \"generatedAt\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-0\": \"reason\",\n    \"3-1\": \"The reason for failure\",\n    \"4-0\": \"currentPage\",\n    \"5-0\": \"totalPages\",\n    \"4-1\": \"The current page\",\n    \"5-1\": \"The total number of pages in the result\",\n    \"7-0\": \"name\",\n    \"7-1\": \"Name of the geofence\",\n    \"8-0\": \"createdAt\",\n    \"9-0\": \"fenceType\",\n    \"8-1\": \"Geofence creation timestamp in UTC\",\n    \"9-1\": \"Type of geofence, circular or polygonal\",\n    \"10-0\": \"radius\",\n    \"10-1\": \"Radius of the geofence, if it is circular\",\n    \"11-0\": \"radiusUnit\",\n    \"13-0\": \"address\",\n    \"14-0\": \"latitude\",\n    \"11-1\": \"Unit of radius of the geofence, if it is circular\",\n    \"13-1\": \"Address of the geofence\",\n    \"14-1\": \"Latitude coordinate of the geofence\",\n    \"15-0\": \"longitude\",\n    \"15-1\": \"Longitude coordinate of the geofence\",\n    \"16-0\": \"alertType\",\n    \"16-1\": \"Type of alert based on the event (vehicle entry and/or exit)\",\n    \"17-0\": \"email\",\n    \"17-1\": \"List of email addresses to which the alert email will be sent\",\n    \"18-0\": \"color\",\n    \"18-1\": \"Color of the geofence\",\n    \"19-0\": \"ccAddress\",\n    \"19-1\": \"Email address(es) to which the alert mail is sent apart from the primary email address\",\n    \"20-0\": \"groupNames\",\n    \"20-1\": \"Names of the groups associated with the geofence\",\n    \"21-0\": \"mode\",\n    \"21-1\": \"Frequency of the alert email. \\n0 - Indicates that the email is sent instantly\\n60 - Indicates that the email is sent once an hour\",\n    \"22-0\": \"reserved1\",\n    \"23-0\": \"reserved2\",\n    \"24-0\": \"reserved3\",\n    \"25-0\": \"reserved4\",\n    \"22-1\": \"Reserved variable for future use\",\n    \"23-1\": \"Reserved variable for future use\",\n    \"24-1\": \"Reserved variable for future use\",\n    \"25-1\": \"Reserved variable for future use\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"6-0\": \"fenceId\",\n    \"6-1\": \"Unique identifier representing the geofence\",\n    \"12-0\": \"geometry\",\n    \"12-1\": \"If the fence type is polygonal, this field returns the latitude and longitude coordinates of the end points of the polygon.\\n\\nFor a circular geofence, this field is null\"\n  },\n  \"cols\": 2,\n  \"rows\": 26\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56308b0b3998420d00a509e9","__v":2,"editedParams":true,"editedParams2":true,"githubsync":"","parentDoc":null,"project":"55926c913735880d005f7c65","user":"55926c39cf9cdb2100b57022","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"createdAt":"2015-10-28T08:44:59.689Z","category":{"sync":{"isSync":false,"url":""},"pages":["563081bf7581b80d00c51c62","56308b0b3998420d00a509e9","563090133998420d00a509f0","5630936a3998420d00a509f5"],"title":"GEOFENCE","slug":"geofence","order":8,"from_sync":false,"reference":true,"_id":"563081713998420d00a509e4","__v":4,"createdAt":"2015-10-28T08:04:01.613Z","project":"55926c913735880d005f7c65","version":"559286c6c39c4b2d00127a71"}}

getView

This API provides you with information about all active geofences present in your account.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

name:
string
Name of the geofence
groupName:
string
Name of the group associated with the geofence
page:
integer1
Page number of the paginated result

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/geofence/view.json?groupName=WestCoast&USA-1&USA-4" } [/block] ##API Response explanation [block:parameters] { "data": { "0-0": "code", "0-1": "API Status Code", "1-0": "message", "1-1": "API Message", "2-0": "generatedAt", "2-1": "API generation timestamp in UTC", "3-0": "reason", "3-1": "The reason for failure", "4-0": "currentPage", "5-0": "totalPages", "4-1": "The current page", "5-1": "The total number of pages in the result", "7-0": "name", "7-1": "Name of the geofence", "8-0": "createdAt", "9-0": "fenceType", "8-1": "Geofence creation timestamp in UTC", "9-1": "Type of geofence, circular or polygonal", "10-0": "radius", "10-1": "Radius of the geofence, if it is circular", "11-0": "radiusUnit", "13-0": "address", "14-0": "latitude", "11-1": "Unit of radius of the geofence, if it is circular", "13-1": "Address of the geofence", "14-1": "Latitude coordinate of the geofence", "15-0": "longitude", "15-1": "Longitude coordinate of the geofence", "16-0": "alertType", "16-1": "Type of alert based on the event (vehicle entry and/or exit)", "17-0": "email", "17-1": "List of email addresses to which the alert email will be sent", "18-0": "color", "18-1": "Color of the geofence", "19-0": "ccAddress", "19-1": "Email address(es) to which the alert mail is sent apart from the primary email address", "20-0": "groupNames", "20-1": "Names of the groups associated with the geofence", "21-0": "mode", "21-1": "Frequency of the alert email. \n0 - Indicates that the email is sent instantly\n60 - Indicates that the email is sent once an hour", "22-0": "reserved1", "23-0": "reserved2", "24-0": "reserved3", "25-0": "reserved4", "22-1": "Reserved variable for future use", "23-1": "Reserved variable for future use", "24-1": "Reserved variable for future use", "25-1": "Reserved variable for future use", "h-0": "Field", "h-1": "Description", "6-0": "fenceId", "6-1": "Unique identifier representing the geofence", "12-0": "geometry", "12-1": "If the fence type is polygonal, this field returns the latitude and longitude coordinates of the end points of the polygon.\n\nFor a circular geofence, this field is null" }, "cols": 2, "rows": 26 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}