{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/geofence/delete.json","auth":"required","results":{"codes":[{"language":"json","code":"{  \n   \"restResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Dec-07-2015, 09:08 AM UTC\",\n      \"currentPage\":null,\n      \"totalPages\":null\n   }\n}","name":"","status":200}]},"settings":"559288b86bf22f170075b794","examples":{"codes":[]},"method":"delete","params":[{"name":"name","type":"string","default":"","desc":"Name of the geofence","required":false,"in":"query","ref":"","_id":"59455a199b82a9000f9ed9c0"}]},"next":{"description":"","pages":[]},"title":"Delete","type":"endpoint","slug":"delete-geofence","excerpt":"This API allows you to delete an existing geofence. You are allowed to delete geofences for those you have access to. Only one geofence can be deleted per API call.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/geofence/delete.json?name=ClientLocation\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Watch Out!\",\n  \"body\": \"This is an irreversible action. Be careful!\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"code\",\n    \"1-0\": \"message\",\n    \"2-0\": \"generatedAt\",\n    \"3-0\": \"reason\",\n    \"4-0\": \"currentPage\",\n    \"5-0\": \"totalPages\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-1\": \"The reason for failure\",\n    \"4-1\": \"The current page\",\n    \"5-1\": \"The total number of pages in the result\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5630936a3998420d00a509f5","editedParams":true,"editedParams2":true,"__v":4,"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"},"parentDoc":null,"project":"55926c913735880d005f7c65","createdAt":"2015-10-28T09:20:42.198Z","githubsync":"","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"}}

deleteDelete

This API allows you to delete an existing geofence. You are allowed to delete geofences for those you have access to. Only one geofence can be deleted per API call.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

name:
string
Name of the geofence

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/geofence/delete.json?name=ClientLocation" } [/block] [block:callout] { "type": "warning", "title": "Watch Out!", "body": "This is an irreversible action. Be careful!" } [/block] ##API Response explanation [block:parameters] { "data": { "0-0": "code", "1-0": "message", "2-0": "generatedAt", "3-0": "reason", "4-0": "currentPage", "5-0": "totalPages", "0-1": "API Status Code", "1-1": "API Message (Success/Failure)", "2-1": "API generation timestamp in UTC", "3-1": "The reason for failure", "4-1": "The current page", "5-1": "The total number of pages in the result", "h-0": "Field", "h-1": "Description" }, "cols": 2, "rows": 6 } [/block]

User Information

Try It Out

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