Delete fence

Decommission notice

Purpose

This endpoint provides a command used to delete fences.

• Information about all affected projects will be sent in the response.
• The delete command can also be used in dry run mode, which removes nothing but sends information about affected projects in the response.

Request data

HTTPS method: DELETE

• 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

1
https://{baseURL}/geofencing/{versionNumber}/fences/{fenceId}?key={Your_API_Key}&adminKey={Your_Admin_Key}&dryRun={true/false}

curl command request format

1
curl -v -XDELETE -H 'https://{baseURL}/geofencing/{versionNumber}/fences/{fenceId}?key={Your_API_Key}&adminKey={Your_Admin_Key}&dryRun={true/false}'

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.

Response data

Response body

1
{
2
  "name": "fence_name",
3
  "id": "fence_id",
4
  "dryRun" : true/false,
5
  "affectedProjects": [
6
    {
7
      "id" : project_1_id,
8
      "name" : project_1_name
9
    },
10
    ... ,
11
    {
12
      "id" : project_N_id,
13
      "name" : project_N_name
14
    }
15
  ]
16
}

Response fields

The following data tables describe all of the fields that can appear in a response.

Response codes

Example

Delete a fence

URL request example

1
https://api.tomtom.com/geofencing/1/fences/aaab6d78-1738-45bd-a78b-ff3a7ba839f3?key={Your_API_Key}&adminKey={Your_Admin_Key}&dryRun=true

Response body example

1
{
2
  "name": "No-fly zone 23",
3
  "id": "aaab6d78-1738-45bd-a78b-ff3a7ba839f3",
4
  "dryRun": true,
5
  "affectedProjects": [
6
    {
7
      "id": "65f88b21-63f8-4dc9-8e5a-330523c57f55",
8
      "name": "Project 1 Name"
9
    },
10
    {
11
      "id": "6608a5c5-d9e8-4589-acb8-1d5bba02b3f8",
12
      "name": "Project 2 Name"
13
    }
14
  ]
15
}