Update dwell time alert rule partially

Service version: 1
Last edit: 2020.11.16
Deprecated

Deprecation notice

November 6, 2020

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

  • This endpoint has been replaced with the generic endpoint to handle all types of Alert Rules: Update alert rule partially.

  • 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 is used to partially update a Dwell Time Alert Rule.

Request data

HTTPS method: PATCH

  • 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 their values. The generic request format is as follows.

URL format

PATCH
URL request example
https://{baseURL}/geofencing/{versionNumber}/alerts/dwell/{ruleId}?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command format

PATCH
Request curl command example
1curl -XPATCH -d '{
2  "enabled": true
3}'
4'https://{baseURL}/geofencing/{versionNumber}/alerts/dwell/{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.
  • 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.

adminKey
string

An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.

PATCH request body

PATCH
PATCH request body - JSON
1{
2  "enabled": true
3}

Request fields

The following table describes the fields that can be used in a request body.

Primary fields

Description

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.


Default value: The previous value.

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

400

Bad request:

  • Field 'enabled' is not provided.

403

Forbidden:

  • Provided Admin Key is invalid.
  • Admin Key is missing.

Example

Partially update the Dwell Time Alert Rule.

Request format

PATCH
URL request example
https://api.tomtom.com/geofencing/1/alerts/dwell/1f9e811f-867b-4d4d-aed9-7d8266fac0ae?key=nQRhDX5saL2KM0dIzEfeX2lcxWk9ktT2qXDZpwCr&adminKey=QekKaqqCHBpFLPCeViVS

PATCH body format

PATCH
PATCH body format - JSON
1{
2  "enabled": false
3}

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": false
10}