Send position

Important note

Before a customer can use the Location History API Send position endpoint they must give consent for the storing of historical positions. Use the Set new settings values endpoint in the Configuration service to do this. Consent for storing historical positions can be revoked at any time.

Purpose

This endpoint is used to send the position of the 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 format

https://{baseURL}/locationHistory/{versionNumber}/history/positions?key={Your_API_Key}

curl command request format

1curl -XPOST "Content-type: application/json" -d
2'{
3   "type": "Feature",
4   "geometry": {
5     "type": "Point",
6     "coordinates": [
7       longitude,
8       latitude,
9       altitude
10     ]
11   },
12   "object": "object_uuid",
13   "timestamp": "YYYY-MM-DDThh:mm:ss"
14 }'
15'https://{baseURL}/locationHistory/{versionNumber}/history/positions?key={Your_API_Key}'

POST request body

1{
2  "type": "Feature",
3  "geometry": {
4    "type": "Point",
5    "coordinates": [
6      longitude,
7      latitude,
8      altitude
9    ]
10  },
11  "object": "object_uuid",
12  "timestamp": "YYYY-MM-DDThh:mm:ss"
13}

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.

POST body request fields

Response data

Response body

The response body is empty.

Response codes

Example

Send a position.

POST request example

https://api.tomtom.com/locationHistory/1/history/positions?key={Your_API_Key}

POST request body example

1{
2  "geometry": {
3    "type": "Point",
4    "coordinates": [5.068704, 52.364897, 0.0]
5  },
6  "object": "cf6eae04-bd5e-4220-ae02-8151e1e8e34f"
7}