Live Data
⚠️ API Deprecated
Please be informed that the getLiveData API has been deprecated.
Going forward, use the getTokenBaseLiveData API.
Why the change?
The legacy getLiveData endpoint lacked authentication, making it vulnerable to brute-force attempts and unauthorized access.
What you need to do
- Update your integrations to call getTokenBaseLiveData.
- Authenticate requests using a valid token as described in the documentation.
This API is meant to get the live data.
Request Parameters
| Parameter | Type | Value | Description |
|---|---|---|---|
| user | String | username | |
| pass | String | password | |
| project_id | Integer | project id | |
| access_token | String | acces token | |
| format | String | json/xml | Format of data and mandatory |
| status | String | status of vehicle | |
| vehicle_no | String | Vehicle Number | |
| imei_no | Integer | IMEI Number | |
| company | String | company is optional | |
| vehicle_name | String | vehicle number | |
| app | String | Application ID | |
| Tformat | String | UTC or null | Timezone format |
| WithSim | Boolean | yes/no | sim |
Description
Method Name
getLiveData
Prerequisites
Before calling this API we need to generate token using generateAccessToken API.
Request
Request interval:- | Every 1 min for vehicle Parameters Every 2 min for company Parameters | |||
Acceptance Criteria
project is start up then licence must not expired .
Request URL
json
Without username and password
http://trace.truckoom.com/webservice?token=getLiveData&imei_no=XXX&format=json
http://trace.truckoom.com/webservice?token=getLiveData&vehicle_no=XXX&format=json
http://trace.truckoom.com/webservice?token=getLiveData&vehicle_name=XXX&format=json
With username and password
(We can write company name in param as company=AAA)
http://trace.truckoom.com/webservice?token=getLiveData&user=AAA&pass=BBB&imei_no=XXX&format=json
http://trace.truckoom.com/webservice?token=getLiveData&user=AAA&pass=BBB&vehicle_no=XXX&format=json
XML
Without username and password
(We can write company name in param as company=AAA)
http://trace.truckoom.com/webservice?token=getLiveData&imei_no=XXX&format=xml
http://trace.truckoom.com/webservice?token=getLiveData&vehicle_no=XXX&format=xml
http://trace.truckoom.com/webservice?token=getLiveData&vehicle_name=XXX&format=xml
With username and password
(We can write company name in param as company=AAA)
http://trace.truckoom.com/webservice?token=getLiveData&user=AAA&pass=BBB&imei_no=XXX&format=xml
http://trace.truckoom.com/webservice?token=getLiveData&user=AAA&pass=BBB&vehicle_no=XXX&format=xml
http://trace.truckoom.com/webservice?token=getLiveData&user=AAA&pass=BBB&vehicle_name=XXX&format=xml
- http://trace.truckoom.com/webservice?token=getLiveData&user=XX&pass=XXXX&company=XXXX&format=json&WithSim=yes
Response
Key | Format | Mandatory | Description |
Vehicle_Name | String | Yes | Vehicle Name |
Company | String | Yes | Company Name |
Temperature | String | Yes | Temperature from temp port |
Latitude | String | Yes | Vehicle Latitude |
GPS | String | Yes | GPS Port Value (ON / OFF) |
Vehicle_No | String | Yes | Vehicle Number |
Door1 | String | Yes | ON / OFF / – |
Door4 | String | Yes | ON / OFF / – |
Branch | String | Yes | Branch Name |
Vehicletype | String | Yes | Vehicle Type ( car, truck, etc) |
Door2 | String | Yes | ON / OFF / – |
Door3 | String | Yes | ON / OFF / – |
GPSActualTime | String | Yes | GPS Data receiving time |
Datetime | String | Yes | Data Insert time |
Status | String | Yes | Vehicle Status |
DeviceModel | String | Yes | GPS Model Name |
Speed | String | Yes | Vehicle Speed |
AC | String | Yes | AC is ON / OFF |
Imeino | String | Yes | IMEI No |
Odometer | String | Yes | Value of Odometer |
POI | String | Yes | Point of Interest or Address Book |
Driver_Middle_Name | String | Yes | Driver middle Name |
Longitude | String | Yes | Vehicle Longitude |
Immobilize_State | String | Yes | Imobilize State ( On / Off) |
IGN | String | Yes | Ignition On / Off |
Driver_First_Name | String | Yes | Driver first name |
Angle | String | Yes | angle |
SOS | String | Yes | SOS is ON / OFF |
Fuel | String | Yes | Fuel Information |
battery_percentage | Number | Yes | Battery in percentage |
ExternalVolt | String | Yes | External Voltage |
Driver_Last_Name | String | Yes | Driver Last Name |
Power | String | Yes | If Power is ON / OFF |
Location | String | Yes | Vehicle Location |
Error Code | Status |
0 | Fail |
1 | Success |
Sample Response
SUCCESS{
"root": {
"VehicleData": [
{
"Vehicle_Name": ".",
"Company": "sddddf",
"Temperature": "--",
"Latitude": "32.375394",
"GPS": "ON",
"Vehicle_No": "ffff",
"Door1": "--",
"Door4": "--",
"Branch": "ggggg",
"Vehicletype": "gggg",
"Door2": "--",
"Door3": "--",
"GPSActualTime": "28-09-2020 22:43:29",
"Datetime": "28-09-2020 22:43:31",
"Status": "INACTIVE",
"DeviceModel": "hhhh",
"Speed": "63",
"AC": "--",
"Imeino": "1233455667",
"Odometer": "57260700",
"POI": "--",
"Driver_Middle_Name": "--",
"Longitude": "-99.090061",
"Immobilize_State": "--",
"IGN": "--",
"Driver_First_Name": "--",
"Angle": "92",
"SOS": "--",
"Fuel": [],
"battery_percentage": 90,
"ExternalVolt": "14.30",
"Driver_Last_Name": "--",
"Power": "--",
"Location": "hhhtrjtrjujytj"
}
]
}
}
FAIL
{
"root": {
"error": "The call exceeded the limit of one/two minute one call."
}
}
FAIL
{
"root": {
"error": "Incorrect username password.."
}
}
FAIL
{
"root": {
"error": "This API service is not available for you."
}
}
FAIL
{
"root": {
"error": "App parameter value is invalid."
}
}
FAIL
{
"root": {
"error": "project_id parameter value is invalid."
}
}
FAIL
{
"root": {
"error": "No Company Found"
}
}
FAIL
{
"root": {
"error": "No Vehicle Found"
}
}
FAIL
{
"root": {
"error": "Vehicle Licence Expired"
}
}
FAIL
{
"root": {
"error": "user inactive "
}
}
FAIL
{
"root": {
"error": "Invalid parameter"
}
}
FAIL
{
"root": {
"error": "No Data Found"
}
}