Developer

Get dwell time alert rule

Service version: 1
Last edit: 2020.11.16
Deprecated

Deprecation notice

November 6, 2020

  • The "Get dwell time alert rule" endpoint has been deprecated.

  • This endpoint has been replaced with the generic endpoint to handle all types of Alert Rules: Get Alert Rule.

  • This endpoint will be withdrawn following a 12 month deprecation period.

  • The planned withdrawal date is December 1, 2021.

  • Following withdrawal, requests to this endpoint may receive an HTTP 404 error in response.

  • More details are available at the TomTom deprecation policy page.

Purpose

This endpoint shows details about the Dwell Time Alert Rule.

Request data

HTTPS method: GET

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL format

get
URL request example
https://{baseURL}/geofencing/{versionNumber}/alerts/dwell/{ruleId}?key={Your_API_Key}

curl command format

get
Request curl command example
curl 'https://{baseURL}/geofencing/{versionNumber}/alerts/dwell/{ruleId}?key={Your_API_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.
  • The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Required parameters

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.

Response data

Response body

Response body - JSON
1{
2  "id": "The id of the alert rule",
3  "name": "The name of the alert rule",
4  "object": "The id of the object",
5  "project": "The id of the project",
6  "fence": "The id of the fence",
7  "maxDwellTime": integer,
8  "notificationGroup": "The id of the notification group",
9  "enabled": true
10}

Response fields

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

Primary fields

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.

maxDwellTime
integer

Maximum time (in seconds) an Object can stay inside a Fence, before alert is risen.

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: An alert is enabled.

  • false: An alert is disabled.

Response codes

Code

Meaning & possible causes

200

OK

404

Not found: Alert with the provided id does not exist.

Example

Get details of the specific Dwell Time Alert Rule.

Request format

get
URL request example
https://api.tomtom.com/geofencing/1/alerts/dwell/1f9e811f-867b-4d4d-aed9-7d8266fac0ae?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3

Response body

Response body - JSON
1{
2  "id": "1f9e811f-867b-4d4d-aed9-7d8266fac0ae",
3  "name": "Airport Kiss&Ride" policy",
4  "object": "*",
5  "project": "ab550513-7026-4c98-9ff7-a930d70b66f8",
6  "fence": "0b16633b-7b2b-4fd6-a834-f36c2250ab6",
7  "maxDwellTime": 600,
8  "notificationGroup": "8e34613a-2324-4749-ac9d-25bf7a91d218",
9  "enabled": true
10}