Update dwell time alert rule partially (Deprecated)
Service version: 1
Last edit: 2020.11.16
On this page
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 Partially 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 is used to partially update a Dwell Time Alert Rule.
Request data
HTTPS method: PATCH
URL format
For ease of viewing and identification:
- Required constants and parameters are shown in bold text.
- Optional parameters are shown in plain text.
https://baseURL/geofencing/versionNumber/alerts/dwell/ruleId?key=Your_API_Key&adminKey=Your_Admin_Key
curl command
curl -XPATCH -d '{
"enabled": true
}'
'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.
- 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. |
PATCH request body
{
"enabled": true
}
Request fields
The following table describes the fields that can be used in a request body.
Primary fields | |
---|---|
Field | Description |
enabled boolean |
The Boolean value that says if an alert rule is enabled or not. Values:
The previous value.
|
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",
"maxDwellTime": integer,
"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. |
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:
|
HTTP response codes
Code | Meaning and possible causes |
---|---|
200 |
OK |
400 |
Bad request:
|
403 |
Forbidden:
|
Examples
Example: Partially update the Dwell Time Alert Rule.
Request format
https://api.tomtom.com/geofencing/1/alerts/dwell/1f9e811f-867b-4d4d-aed9-7d8266fac0ae?key=nQRhDX5saL2KM0dIzEfeX2lcxWk9ktT2qXDZpwCr&adminKey=QekKaqqCHBpFLPCeViVS
PATCH body format
{
"enabled": false
}
Response body
{
"id": "1f9e811f-867b-4d4d-aed9-7d8266fac0ae"
"name": "Airport Kiss&Ride" policy",
"object": "*",
"project": "ab550513-7026-4c98-9ff7-a930d70b66f8",
"fence": "0b16633b-7b2b-4fd6-a834-f36c2250ab6",
"maxDwellTime": 600,
"notificationGroup": "8e34613a-2324-4749-ac9d-25bf7a91d218",
"enabled": false
}