Token Base Live Data
This API will return Vehicle Live Data based on auth-token and provided json data
Request Parameters
Parameter | Type | Value | Description |
---|---|---|---|
auth-code | String | It is Mandatory and we have to pass Generated token in header of the request | |
company_names | String | Comma separated Company Names and is not mandatory. | |
vehicle_nos | String | Comma separated vehicle Numbers and is not mandatory. | |
imei_nos | String | comma separated IMEI numbers |
Description
Method Name
getTokenBaseLiveData
prerequisite
- Need to generate token using generateAccessToken API to run this API.
Request
Request Format | json |
{
"company_names" : "XXXX" ,
"vehicle_nos" : "XXXX",
"imei_nos" : "54874848",
"format" : "XXXX"
}
Response
Key | Format | Mandatory | Description |
root | json | yes | Contains Vehicle Data |
root.VehicleData | array | yes | Contains vehicle data |
root.VehicleData.Vehicle_Name | String | yes | Vehicle Name |
root.VehicleData.Company | String | yes | Company Name |
root.VehicleData.Temperature | String | yes | Temperature from temp port |
root.VehicleData.Latitude | String | yes | Vehicle Latitude |
root..VehicleData.GPS | String | yes | GPS Port Value (ON / OFF) |
root..VehicleData.Vehicle_No | String | yes | Vehicle Number |
root..VehicleData.Door1 | String | yes | ON / OFF / – |
root.VehicleData.Door4 | String | yes | ON / OFF / – |
root.VehicleData.Branch | String | yes | Branch Name |
root.VehicleData.Vehicletype | String | yes | Vehicle Type ( car, truck, etc) |
root.VehicleData.Door2 | String | yes | ON / OFF / – |
root.VehicleData.Door3 | String | yes | ON / OFF / – |
root.VehicleData.GPSActualTime | String | yes | GPS Data receiving time |
root.VehicleData.Datetime | String | yes | Data Insert time |
root.VehicleData.Status | String | yes | Vehicle Status |
root.VehicleData.DeviceModel | String | yes | GPS Model Name |
root.VehicleData.Speed | String | yes | Vehicle Speed |
root.VehicleData.AC | String | yes | AC is ON / OFF |
root.VehicleData.Imeino | String | yes | IMEI No |
root.VehicleData.Odometer | String | yes | Value of Odometer |
root.VehicleData.POI | String | yes | Point of Interest or Address Book |
root.VehicleData.Driver_Middle_Name | String | yes | Driver middle Name |
root.VehicleData.Longitude | String | yes | Vehicle Longitude |
root.VehicleData.Immobilize_State | String | yes | Immobilize State ( On / Off) |
root.VehicleData.IGN | String | yes | Ignition On / Off |
root.VehicleData.Driver_First_Name | String | yes | Driver first name |
root.VehicleData.Angle | String | yes | angle |
root.VehicleData.SOS | String | yes | SOS is ON / OFF |
root.VehicleData.Fuel | String | yes | Fuel Information |
root.VehicleData.battery_percentage | Number | yes | Battery in percentage |
root.VehicleData.ExternalVolt | String | yes | External Voltage |
root.VehicleData.Driver_Last_Name | String | yes | Driver Last Name |
root.VehicleData.Power | String | yes | If Power is ON / OFF |
root.VehicleData.Location | String | yes | Vehicle Location |
root.VehicleData.Fuel.port_name | String | No | Port name |
root.VehicleData.Fuel.value | String | No | value |
root.VehicleData.username | String | yes | User name of company |
root.VehicleData.satellite_count | Number | yes | Satellite Count |
root.VehicleData.gps_hdop | String | yes | gps hdop |
root.VehicleData.mcc | String | yes | MCC |
root.VehicleData.mnc | String | yes | MNC |
root.VehicleData.cellid | String | yes | cell Id |
root.VehicleData.Ibutton/RFID | String | yes | Ibutton/RFID Driver Tag |
root.VehicleData.Altitude | String | yes | Altitude |
root.VehicleData.lac | String | yes | lac |
Error Code | Status |
0 | FAIL |
1 | SUCCESS |
Sample Response
SUCCESS{
"root": {
"VehicleData": [
{
"Vehicle_Name": "Temperature sensor 2",
"Company": "Telematics Nepal",
"Temperature": "lls lvl add1(FUEL 1) : 0.0",
"heartbeat": "no",
"Latitude": "28.0581646",
"GPS": "ON",
"mcc": "2",
"cellid": "NA",
"Vehicle_No": "Temperature sensor 2",
"Door1": "--",
"elock": "--",
"Door4": "--",
"Branch": "Telematics Nepal",
"Vehicletype": "Default",
"Door2": "--",
"Door3": "--",
"course": "",
"GPSActualTime": "12-06-2024 17:39:02",
"Datetime": "12-06-2024 17:39:15",
"Status": "STOP",
"DeviceModel": "FMS500 STCAN",
"Speed": "0",
"AC": "--",
"mnc": "429",
"Imeino": "860922040743878",
"gps_hdop": "NA",
"Odometer": "0",
"Temperature1": "0.0",
"POI": "--",
"Driver_Middle_Name": "null",
"Longitude": "81.6228256",
"Immobilize_State": "--",
"IGN": "--",
"satellite_count": 9,
"Driver_First_Name": "Payal",
"Angle": "12",
"Ibutton/RFID": "186484484",
"SOS": "--",
"Fuel": [
{
"port_name": "ADC6",
"value": 3997
}
],
"battery_percentage": "0",
"ExternalVolt": "--",
"Driver_Last_Name": "test",
"Power": "--",
"username": "aatish@telematics.com.np",
"Location": "Bhawani Baghiya Road,Bhairabgunj Tole,Kumaran Tole,002, 002, Nepal (NW)",
"Altitude": "135",
"lac": ""
}
]
}
}
FAIL
{
"result": 0,
"data": {
"address_book": []
},
"message": "Refresh Token Expired"
}
FAIL
{
"result": 0,
"message": "Error in Service : Data Not Found !"
}
FAIL
{
"result": 0,
"data": {
"address_book": []
},
"message": "Invalid Token"
}
FAIL
{
"result": 0,
"message": "54874848 Does Not Belongs To Given User"
}
FAIL
{
"root": {
"error": "The call exceeded the limit of one minute one call."
}
}
FAIL
{
"result": 0,
"data": {},
"message": "No Company Found For Given User"
}
FAIL
{
"result": 0,
"data": { },
"message": "No Vehicle Found For Given User"
}
FAIL
{
"result": 0,
"message": "abc company Does Not Belongs To Given User"
}
FAIL
{
"result": 0,
"message": "xyz vehicle Does Not Belongs To Given User"
}
Response codes
Code | Description |
---|
Error codes
Code | Name | Description |
---|