Sorry, you need to enable JavaScript to visit this website.
Geofencing API
Get your key

Delete transition alert rule

 

Service version: 1
Last edit: 2020.09.30

On this page

Purpose

This endpoint is used to delete a Transition Alert Rule.

We highly recommend using the new, generic endpoint to handle all types of Alert Rules: Delete Alert Rule.

Request data

HTTPS method: DELETE

URL format

For ease of viewing and identification:

  • Required constants and parameters are shown in bold text.
  • Optional parameters are shown in normal text.
https://baseURL/geofencing/versionNumber/alerts/transitions/ruleId?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -XDELETE 'https://baseURL/geofencing/versionNumber/alerts/transitions/ruleId?key=Your_API_Key&adminKey=Your_Admin_Key'

Request parameters

The following table describes the parameters that can be used in a Request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
  • The order of Request parameters is not important.
Required parameters
Parameter Description
baseURL
string 		The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string 		Service version.
Value: 1
ruleId
string 		The UUID of the alert rule.
key
string 		An API Key valid for the requested service.
Value: Your valid API Key.
adminKey
string 		An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.
Optional parameters
Note: There are no optional parameters in this endpoint.

▲ Return to top

Response data

Response body

{
  "id": "The id of the alert rule",
  "name": "The name of the alert rule",
  "object": "The id of the object",
  "project": "The id of the project",
  "fence": "The id of the fence",
  "transitionType": "ALL",
  "notificationGroup": "The id of the notification group",
  "enabled": true
}

Response fields

The following table describes all of the fields that can appear in a Response.

Primary fields
Field Description
id
string 		The UUID of the alert rule.
name
string 		The name of the alert rule.
object
string 		The UUID of the object or * for any object in configuration.
project
string 		The UUID of the project or * for any project in configuration.
fence
string 		The UUID of the fence or * for any fence in configuration.
transitionType
string 		The type of the transition to alert.
Possible values:
  • "ENTER" - when object just entered the fence
  • "EXIT" - when object just exited the fence
  • "ALL" - when object just entered or exited the fence
notificationGroup
string 		The UUID of the owned group in the Notification Service to send the alert rule.
enabled
boolean 		The Boolean value that says if an alert rule is enabled or not.
Values:
  • true - alert is enabled
  • false - alert is disabled

HTTP Response codes

Code Meaning and possible causes
200 Deleted
403 Forbidden:
  • The provided Admin Key is invalid.
  • The Admin Key is missing.
404 Not found: Alert with the provided id does not exist.

▲ Return to top

Examples

Example: Delete specific Transition Alert Rule.

Request format

https://api.tomtom.com/geofencing/1/alerts/transitions/1f9e811f-867b-4d4d-aed9-7d8266fac0ae?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8

Response body

{
  "id": "1f9e811f-867b-4d4d-aed9-7d8266fac0ae"
  "name": "Airport transition alert",
  "object": "*",
  "project": "ab550513-7026-4c98-9ff7-a930d70b66f8",
  "fence": "0b16633b-7b2b-4fd6-a834-f36c2250ab6",
  "transitionType": "ALL",
  "notificationGroup": "8e34613a-2324-4749-ac9d-25bf7a91d218",
  "enabled": true
}

▲ Return to top