Add new object

Decommission notice

Purpose

This endpoint creates a new object.

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

1
https://{baseURL}/locationHistory/{versionNumber}/objects/object?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

1
curl -XPOST "Content-type: application/json" -d
2
'{
3
   "name": "object_name",
4
   "properties": {
5
     "key": "value"
6
   }
7
 }'
8
'https://{baseURL}/locationHistory/{versionNumber}/objects/object?key={Your_API_Key}&adminKey={Your_Admin_Key}'

POST request body format (JSON)

1
{
2
  "name": "object_name",
3
  "properties": {
4
    "key": "value"
5
  }
6
}

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.

Response data

Response body

1
{
2
  "name": "object_name",
3
  "id": "object_id",
4
  "properties": {
5
    "key": "value"
6
  }
7
}

Response fields

The following table describes all of the fields that can appear in a response.

Response codes

Example

Add a new object.

Request URL example

1
https://api.tomtom.com/locationHistory/1/objects/object?key={Your_API_Key}&adminKey={Your_Admin_Key}

POST request body example

1
{
2
  "name": "Support car 1",
3
  "properties": {
4
    "embeddedId": "EL 11111",
5
    "maxSpeedKmh": 70,
6
    "driver": "John Doe"
7
  }
8
}

Response body example

1
{
2
  "name": "Support car 1",
3
  "id": "cfde72d8-4b9f-4f6d-83c8-87ae0465fd5d",
4
  "properties": {
5
    "embeddedId": "EL 11111",
6
    "maxSpeedKmh": 70,
7
    "driver": "John Doe"
8
  }
9
}