Delete fence

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.

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 plain text.

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

curl command

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.
• 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.

Response body

{
  "name": "fence_name",
  "id": "fence_id",
  "dryRun" : true/false,
  "affectedProjects": [
    {
      "id" : project_1_id,
      "name" : project_1_name
    },
    ... ,
    {
      "id" : project_N_id,
      "name" : project_N_name
    }
  ]
}

Response fields

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

HTTP response codes

Request URL

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

Response body (JSON)

{
  "name": "No-fly zone 23",
  "id": "aaab6d78-1738-45bd-a78b-ff3a7ba839f3",
  "dryRun": true,
  "affectedProjects": [
    {
      "id": "65f88b21-63f8-4dc9-8e5a-330523c57f55",
      "name": "Project 1 Name"
    },
    {
      "id": "6608a5c5-d9e8-4589-acb8-1d5bba02b3f8",
      "name": "Project 2 Name"
    }
  ]
}