Add new project
Purpose
This endpoint creates a new project and assigns it to a customer's configuration.
Request data
HTTPS method: POST
- 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
https://{baseURL}/geofencing/{versionNumber}/projects/project?key={Your_API_Key}&adminKey={Your_Admin_Key}
curl command request format
1curl -v -XPOST -H "Content-type: application/json" -d2'{3 "name": "a_project_name"4 }'5'https://{baseURL}/geofencing/{versionNumber}/projects/project?key={Your_API_Key}&adminKey={Your_Admin_Key}'
POST request body format
1{2 "name": "a_project_name"3}
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 |
---|---|
| The base URL for calling the API. |
| Service version number. |
| An API Key valid for the requested service. |
| An Admin Key valid for the provided API key. |
Response data
Response body
The following JSON code block demonstrates a successful response from the API server.
1{2 "name": "a_project_name",3 "id": "a_project_id"4}
Response fields
The following table describes all of the fields that can appear in a response.
Primary fields | Description |
---|---|
| The name of the project. |
| The UUID of the project. |
Response codes
Code | Meaning & possible causes |
---|---|
| Created. |
| Bad request: Project name already used. |
| Forbidden:
|
Example
Add a new project
URL request example
https://api.tomtom.com/geofencing/1/projects/project?key={Your_API_Key}&adminKey={Your_Admin_Key}
POST request body example
1{2 "name": "Airports in Germany"3}
Response body example
1{2 "name": "Airports in Germany",3 "id": "44de824d-c368-46cf-a234-a6792682dfd6"4}