Call: https://www.outreach.xyz/api/locate2
Verb: POST
Body:
{
"imei": "354015434303025",
"points": 5,
"startdate": "2022-10-19T23:00:00.000Z",
"enddate": "2022-10-20T22:59:59.999Z"
}Request Body Parameters:
imei: Unique device identifier - mandatory
points: Number of points to return - range 1 to 100 - mandatory
startdate: ISO8601 formatted start date of the earliest time in the window - optional
enddate: ISO8601 formatted end date if the window for retrieval - optional
NOTE:
Only IMEI and POINTS are mandatory. If a request is sent as follows, then the most recent point is always returned.
{
"imei": "354015434303025",
"points": 1
}Response:
BODY:
{
"success": true,
"message": null,
"points": [
{
"imei": "354015434303025",
"data_bucket": "19285",
"timestamp": "2022-10-20T19:05:12.000Z",
"acc_state": 1,
"altitude": 45,
"analogue_1": 0,
"analogue_2": 0,
"analogue_3": 0,
"analogue_4": 0,
"angle": 299,
"battery": 96,
"battery_current": 0,
"battery_voltage": 4001,
"button_id": 0,
"cell_id": 0,
"cid": "",
"dallas_temperature_1": 0,
"dallas_temperature_2": 0,
"dallas_temperature_3": 0,
"device_type": "FMBXXX",
"digital_1": true,
"digital_2": false,
"digital_3": false,
"digital_4": false,
"digital_output_1": 0,
"digital_output_2": 0,
"eco_score": 1000,
"external_power_voltage": 28948,
"green_driving_type": 0,
"green_driving_value": 0,
"gsensor_state": 0,
"hdop": 4,
"ibutton_id": "0000000000000000",
"id": "20f23500-50aa-11ed-b92a-2a4237cee4fb",
"lac": "",
"lat": "53.3123816",
"location_type": "GPS",
"long": "-2.4213999",
"movement": 0,
"movement_sensor": 1,
"pdop": 6,
"relay_state": 0,
"roaming": 0,
"satellites": 17,
"signal": 3,
"speed": 87,
"vdop": 0
},
{
"imei": "354015434303025",
"data_bucket": "19285",
"timestamp": "2022-10-20T19:05:21.000Z",
"acc_state": 1,
"altitude": 44,
"analogue_1": 0,
"analogue_2": 0,
"analogue_3": 0,
"analogue_4": 0,
"angle": 311,
"battery": 96,
"battery_current": 0,
"battery_voltage": 4001,
"button_id": 0,
"cell_id": 0,
"cid": "",
"dallas_temperature_1": 0,
"dallas_temperature_2": 0,
"dallas_temperature_3": 0,
"device_type": "FMBXXX",
"digital_1": true,
"digital_2": false,
"digital_3": false,
"digital_4": false,
"digital_output_1": 0,
"digital_output_2": 0,
"eco_score": 1000,
"external_power_voltage": 28953,
"green_driving_type": 0,
"green_driving_value": 0,
"gsensor_state": 0,
"hdop": 4,
"ibutton_id": "0000000000000000",
"id": "26568460-50aa-11ed-b873-4a797413b131",
"lac": "",
"lat": "53.3135266",
"location_type": "GPS",
"long": "-2.42401",
"movement": 0,
"movement_sensor": 1,
"pdop": 6,
"relay_state": 0,
"roaming": 0,
"satellites": 16,
"signal": 3,
"speed": 85,
"vdop": 0
},
{
"imei": "354015434303025",
"data_bucket": "19285",
"timestamp": "2022-10-20T19:05:30.000Z",
"acc_state": 1,
"altitude": 48,
"analogue_1": 0,
"analogue_2": 0,
"analogue_3": 0,
"analogue_4": 0,
"angle": 317,
"battery": 96,
"battery_current": 0,
"battery_voltage": 4001,
"button_id": 0,
"cell_id": 0,
"cid": "",
"dallas_temperature_1": 0,
"dallas_temperature_2": 0,
"dallas_temperature_3": 0,
"device_type": "FMBXXX",
"digital_1": true,
"digital_2": false,
"digital_3": false,
"digital_4": false,
"digital_output_1": 0,
"digital_output_2": 0,
"eco_score": 1000,
"external_power_voltage": 28955,
"green_driving_type": 0,
"green_driving_value": 0,
"gsensor_state": 0,
"hdop": 4,
"ibutton_id": "0000000000000000",
"id": "2bed5570-50aa-11ed-93f5-2bf99f2da9d1",
"lac": "",
"lat": "53.31494",
"location_type": "GPS",
"long": "-2.4262699",
"movement": 0,
"movement_sensor": 1,
"pdop": 7,
"relay_state": 0,
"roaming": 0,
"satellites": 18,
"signal": 3,
"speed": 86,
"vdop": 0
},
{
"imei": "354015434303025",
"data_bucket": "19285",
"timestamp": "2022-10-20T19:05:39.000Z",
"acc_state": 1,
"altitude": 53,
"analogue_1": 0,
"analogue_2": 0,
"analogue_3": 0,
"analogue_4": 0,
"angle": 317,
"battery": 96,
"battery_current": 0,
"battery_voltage": 4000,
"button_id": 0,
"cell_id": 0,
"cid": "",
"dallas_temperature_1": 0,
"dallas_temperature_2": 0,
"dallas_temperature_3": 0,
"device_type": "FMBXXX",
"digital_1": true,
"digital_2": false,
"digital_3": false,
"digital_4": false,
"digital_output_1": 0,
"digital_output_2": 0,
"eco_score": 1000,
"external_power_voltage": 28957,
"green_driving_type": 0,
"green_driving_value": 0,
"gsensor_state": 0,
"hdop": 4,
"ibutton_id": "0000000000000000",
"id": "310113d0-50aa-11ed-b5b0-d8e0491de800",
"lac": "",
"lat": "53.3164",
"location_type": "GPS",
"long": "-2.4284199",
"movement": 0,
"movement_sensor": 1,
"pdop": 6,
"relay_state": 0,
"roaming": 0,
"satellites": 17,
"signal": 3,
"speed": 84,
"vdop": 0
},
{
"imei": "354015434303025",
"data_bucket": "19285",
"timestamp": "2022-10-20T19:05:48.000Z",
"acc_state": 1,
"altitude": 56,
"analogue_1": 0,
"analogue_2": 0,
"analogue_3": 0,
"analogue_4": 0,
"angle": 317,
"battery": 96,
"battery_current": 0,
"battery_voltage": 4001,
"button_id": 0,
"cell_id": 0,
"cid": "",
"dallas_temperature_1": 0,
"dallas_temperature_2": 0,
"dallas_temperature_3": 0,
"device_type": "FMBXXX",
"digital_1": true,
"digital_2": false,
"digital_3": false,
"digital_4": false,
"digital_output_1": 0,
"digital_output_2": 0,
"eco_score": 1000,
"external_power_voltage": 28958,
"green_driving_type": 0,
"green_driving_value": 0,
"gsensor_state": 0,
"hdop": 5,
"ibutton_id": "0000000000000000",
"id": "365313b0-50aa-11ed-a444-8ed824ac2ec6",
"lac": "",
"lat": "53.3178766",
"location_type": "GPS",
"long": "-2.4305816",
"movement": 0,
"movement_sensor": 1,
"pdop": 8,
"relay_state": 0,
"roaming": 0,
"satellites": 15,
"signal": 3,
"speed": 85,
"vdop": 0
}
]
}Field Definitions:
The data list returned has the following notable fields:
Success
This field denotes if the call was a success
Message
This field will contain a descriptive message if the success field is false
Points
This field is a JSON array of the points requested
Points Array Notable Fields:
The following fields are notable. Information on other fields (if not obvious) can be available on request
imei: unique identifier for the tracking device
timestamp: timestamp of the record in ISO8601 format
acc_state: Value of the vehicle ignition
altitude: value in metres of the height above sea-level as per the GPS measurement
external_power_voltage: voltage of the vehicle battery in millivolts
lat: GPS Latitude of the point
long: GPS Longitude of the point
location_type: Type of location. Can be GPS, WIFI
satellites: Number of satellites in view
signal: GSM signal value – range 1 to 5
speed: Speed of vehicle in KMH