Get project details

Decommission notice

Purpose

This endpoint gets all the fences and other details for a project. This can include objects for which the project is a default.

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

URL request format

1
https://{baseURL}/geofencing/{versionNumber}/projects/{projectId}?&key={Your_API_Key}&defaultObjects={true/false}

curl command request format

1
curl 'https://{baseURL}/geofencing/{versionNumber}/projects/{projectId}?&key={Your_API_Key}&defaultObjects={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

The following JSON code block demonstrates a successful response from the API server.

1
{
2
  "name": "project_name",
3
  "id": "project_id",
4
  "fences": [
5
    {
6
      "id": "fence_id",
7
      "name": "fence_name",
8
      ...
9
    }
10
  ],
11
  "defaultObjects": [
12
    {
13
      "id": "object_id",
14
      "name": "object_name",
15
      ...
16
    }
17
  ]
18
}

Response fields

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

Response codes

Example

Get project details

Get details of the “Cities in the Netherlands” (id: 44de824d-c368-46cf-a234-a6792682dfd6) project, including a list of objects that have this project set as their default project.

URL request example

1
https://api.tomtom.com/geofencing/1/projects/44de824d-c368-46cf-a234-a6792682dfd6?key={Your_API_Key}&defaultObjects=true

Response body example

1
{
2
  "name": "project_name",
3
  "id": "project_id",
4
  "fences": [
5
    {
6
      "id": "fence_id",
7
      "name": "fence_name",
8
      ...
9
    }
10
  ],
11
  "defaultObjects": [
12
    {
13
      "id": "object_id",
14
      "name": "object_name",
15
      ...
16
    }
17
  ]
18
}