Table of contents

1.Ac Report
• 1.1 Input parameters
• 1.2 Specific Parameter
• 1.3 URL Example
• 1.4 Response

2.Primary Engine
• 2.1 Input Parameters
• 2.2 Specific Parameters
• 2.3 Url Example
• 2.4 Response

3.Idle Wastage
• 3.1 Input Parameters
• 3.2 Specific Parameters
• 3.3 Url Example
• 3.4 Response

4.Secondary Engine On
• 4.1 Input Parameters
• 4.2 Specific Parameters
• 4.3 Url Example
• 4.4 Response

5.Temperature Report
• 5.1 Input Parameters
• 5.2 Specific Parameters
• 5.3 Url Example
• 5.4 Response

6.Temperature Deviation
• 6.1 Input Parameters
• 6.2 Specific Parameters
• 6.3 Url Example
• 6.4 Response

7.Radio frequency identification report
• 7.1 Input Parameters
• 7.2 Specific Parameters
• 7.3 Url Example
• 7.4 Response

8.Radio frequency identification report tag
• 8.1 Input Parameters
• 8.2 Specific Parameters
• 8.3 Url Example
• 8.4 Response

9.Protocol Report - DeviceData
• 9.1 Input Parameters
• 9.2 Specific Parameters
• 9.3 Url Example
• 9.4 Response

10.Protocol Report - DataConsumption
• 10.1 Input Parameters
• 10.2 Specific Parameters
• 10.3 Url Example
• 10.4 Response

11.Consolidated Fuel Theft Report
• 11.1 Input Parameters
• 11.2 Specific Parameters
• 11.3 Url Example
• 11.4 Response

12.Consolidated Fuel Report
• 12.1 Input Parameters
• 12.2 Specific Parameters
• 12.3 Url Example
• 12.4 Response

13.Dashboard
• 13.1 Input Parameters
• 13.2 Specific Parameters
• 13.3 Url Example
• 13.4 Response

14.Consolidated Report
• 14.1 Input Parameters
• 14.2 Specific Parameters
• 14.3 Url Example
• 14.4 Response

15.Consolidated site & location
• 15.1 Input Parameters
• 15.2 Specific Parameters
• 15.3 Url Example
• 15.4 Response

16.Consolidated OverSpeed
• 16.1 Input Parameters
• 16.2 Specific Parameters
• 16.3 Url Example
• 16.4 Response

17.Consolidated Stoppage
• 17.1 Input Parameters
• 17.2 Specific Parameters
• 17.3 Url Example
• 17.4 Response

18.Consolidated Site Report
• 18.1 Input Parameters
• 18.2 Specific Parameters
• 18.3 Url Example
• 18.4 Response

19.Tollgate Report
• 19.1 Input Parameters
• 19.2 Specific Parameters
• 19.3 Url Example
• 19.4 Response

20.Travel Summary Report
• 20.1 Input Parameters
• 20.2 Specific Parameters
• 20.3 Url Example
• 20.4 Response

21.Site Stoppage Alert Report
• 21.1 Input Parameters
• 21.2 Specific Parameters
• 21.3 Url Example
• 21.4 Response

22.Executive Summary report
• 22.1 Input Parameters
• 22.2 Specific Parameters
• 22.3 Url Example
• 22.4 Response

23.Executive Summary report - Monthly Dist
• 23.1 Input Parameters
• 23.2 Specific Parameters
• 23.3 Url Example
• 23.4 Response

24.Daily Performance
• 24.1 Input Parameters
• 24.2 Specific Parameters
• 24.3 Url Example
• 24.4 Response

25.Monthly Performance
• 25.1 Input Parameters
• 25.2 Specific Parameters
• 25.3 Url Example
• 25.4 Response

26.Executive Fuel Report
• 26.1 Input Parameters
• 26.2 Specific Parameters
• 26.3 Url Example
• 26.4 Response

27.Monthly Distance and Fuel Report
• 27.1 Input Parameters
• 27.2 Specific Parameters
• 27.3 Url Example
• 27.4 Response

28.Fuel Analytics
• 28.1 Input Parameters
• 28.2 Specific Parameters
• 28.3 Url Example
• 28.4 Response

29.Dispenser Report
• 29.1 Input Parameters
• 29.2 Specific Parameters
• 29.3 Url Example
• 29.4 Response

30.Geofence Fuel Report
• 30.1 Input Parameters
• 30.2 Specific Parameters
• 30.3 Url Example
• 30.4 Response

31.fuel Raw Data report.
• 31.1 Input Parameters
• 31.2 Specific Parameters
• 31.3 Url Example
• 31.4 Response

32.Vehicle Wise Fuel Report
• 32.1 Input Parameters
• 32.2 Specific Parameters
• 32.3 Url Example
• 32.4 Response

33.Vehicle Wise Intraday Report
• 33.1 Input Parameters
• 33.2 Specific Parameters
• 33.3 Url Example
• 33.4 Response

34.Fuel Notification Report
• 34.1 Input Parameters
• 34.2 Specific Parameters
• 34.3 Url Example
• 34.4 Response

35.Movement Report
• 35.1 Input Parameters
• 35.2 Specific Parameters
• 35.3 Url Example
• 35.4 Response

36.Overspeed Report
• 36.1 Input Parameters
• 36.2 Specific Parameters
• 36.3 Url Example
• 36.4 Response

37.Parked Report
• 37.1 Input Parameters
• 37.2 Specific Parameters
• 37.3 Url Example
• 37.4 Response

38.Idle Report
• 38.1 Input Parameters
• 38.2 Specific Parameters
• 38.3 Url Example
• 38.4 Response

39.Ignition Report
• 39.1 Input Parameters
• 39.2 Specific Parameters
• 39.3 Url Example
• 39.4 Response

40.Site Trip
• 40.1 Input Parameters
• 40.2 Specific Parameters
• 40.3 Url Example
• 40.4 Response

41.Trip Summary
• 41.1 Input Parameters
• 41.2 Specific Parameters
• 41.3 Url Example
• 41.4 Response

42.No Data
• 42.1 Input Parameters
• 42.2 Specific Parameters
• 42.3 Url Example
• 42.4 Response

43.Route Deviation.
• 43.1 Input Parameters
• 43.2 Specific Parameters
• 43.3 Url Example
• 43.4 Response

44.Single Track
• 44.1 Input Parameters
• 44.2 Specific Parameters
• 44.3 Url Example
• 44.4 Response

45.Multi Track
• 45.1 Input Parameters
• 45.2 Specific Parameters
• 45.3 Url Example
• 45.4 Response

46.History
• 46.1 Input Parameters
• 46.2 Specific Parameters
• 46.3 Url Example
• 46.4 Response

47.Add sites/geofence
• 47.1 Input Parameters
• 47.2 Specific Parameters
• 47.3 Url Example
• 47.4 Response

48.Alarm Report
• 48.1 Input Parameters
• 48.2 Specific Parameters
• 48.3 Url Example
• 48.4 Response

49.Edit Notification
• 49.1 Input Parameters
• 49.2 Specific Parameters
• 49.3 Url Example
• 49.4 Response

50.Get Url
• 50.1 Input Parameters
• 50.2 Specific Parameters
• 50.3 Url Example
• 50.4 Response

51.Get Apikey
• 51.1 Input Parameters
• 51.2 Specific Parameters
• 51.3 Url Example
• 51.4 Response

52.Geofence Shift Report
• 52.1 Input Parameters
• 52.2 Specific Parameters
• 52.3 Url Example
• 52.4 Response

53.Gps Per Day
• 53.1 Input Parameters
• 53.2 Specific Parameters
• 53.3 Url Example
• 53.4 Response

54.Get Live Locations
• 54.1 Input Parameters
• 54.2 URL Example
• 54.3 Response

55.Summary
• 55.1 Security
• 55.2 Open API Usage Scenarios
• 55.3 Usage Workflow

56.API Summary
• 56.1 Common Parameters
• 56.2 Parameter Encoding
• 56.3 HTTP MIME Type

57.API Listing
• 57.1 Acquire API Key
• 57.2 Input Parameters
• 57.3 URL Example
• 57.4 Response

58.FMS Report

1.Ac Report

This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/public/getAcReport

HTTP Method： GET

Input Parameters：vehicleId, fromDateUTC, toDateUTC

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	Yes	-	For giving vehicle ID
fromDateUtc	Date	Yes	-	fromDateUTC used to get the date
toDateUTC	Date	Yes	-	toDateUTC used to get the date

Url Example:

http://domainname/public/getAcReport?vehicleId=XYZ&fromTimeUtc=1671647400000&toTimeUtc=1671708722000

Response:

Field	Type	Description
AlarmTime	String	To getting the date and time
address	String	To get the vehicle location
lat(Latitude)	String	To get the location
lng(Longitude)	String	To get the location

2.Primary Engine

Get the history of specific vehicle for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getPrimaryEngineReport

HTTP Method： GET

Input Parameters: vehicleId, fromDateUTC, toDateUTC

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	Yes	-	For giving vehicle ID
fromDateUtc	Date	Yes	-	fromDateUTC used to get the date
toDateUTC	Date	Yes	-	toDateUTC used to get the date

Url Example:

http://domainname/getPrimaryEngineReport?vehicleId=XYZ&fromDateTime=1671388200000&toDateTime=1671688098000

Response:

Field	Type	Description
Date	String	To getting the date and time
address	String	To get the vehicle location
ignitionSatus	String	To know the status ON or OFF
Latitude	String	To get the location
Longitude	String	To get the location

3.Idle wastage

Get the idle wastage. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/idleWaste?

HTTP Method： GET

Input Parameters： date, angleIdleTime, idleTime, lat, lng, address

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	Yes	-	For giving vehicle ID
fromDateUtc	Date	Yes	-	fromDateUTC used to get the date
toDateUTC	Date	Yes	-	toDateUTC used to get the date

Url Example:

http://domainname/idleWaste?vid=OTTO-01&vg=OTTO:SMP&tn=ac

Response:

Field	Type	Description
Date	String	To getting the date and time
address	String	Address for the current lat and lng
idleTime	Integer	It shows idle time of vehicle
angleIdleTime	Integer	It shows idle time of vehicle with the postion of vehicle
Lat	String	To get latitude of thesite
Lng	String	To get longitude of the site

4.Secondary Engine On

Get the history of specific vehicle for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getAcReport?

HTTP Method： GET

Input Parameters： Vehicleid, fromTimeUtc, toTimeUtc

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	Yes	-	For giving vehicle ID
fromTimeUtc	long	Yes	-	fromTimeUTC is used to give time
toTimeUtc	long	Yes	-	toTimeUtc is used to give time

Url Example:

http://domainname/getAcReport?vehicleId=XYZ&fromTimeUtc=1671733800000&toTimeUtc=1671780477000

Response:

Field	Type	Description
alarmTime	String	To getting the date and time
alarmType	String	To check ON and OFF status
temp	Integer	temp for Temperature
address	Integer	To get the vehicle location
Lat	String	To get latitude of the site
Lng	String	To get longitude of the site

5.Temperature Report

Get the Temperature report. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getTemperatureReport?

HTTP Method： GET

Input Parameters： Vehicleid, fromDate, fromTime, toTime, toDate, interval, fromDateUTC, toDateUTC

Parameters

Name	Type	Required	Default Value	Desc
Vehicleid	String	Yes	-	For get vehicle ID
fromDate	Date	Yes	-	used to get the date
fromTime	long	Yes	-	fromTime is used to get time
toDate	Date	Yes	-	toDate is used to get date
totime	long	Yes	-	toTime is used to get time
interval	long	Yes	-	used to get time interval
fromDateUTC	Date	Yes	-	toTimeUtc is used to get time
toDateUTC	Date	Yes	-	toTimeUtc is used to get time

Url Example:

http://domainname/getTemperatureReport?vehicleId=XYZ&fromDate=2022-12-23&fromTime=0:0:00&toDate=2022-12-23&toTime=14:44:00&interval=-1&fromDateUTC=1671733800000&toDateUTC=1671786840000

Response:

Field	Type	Description
data	String	To getting the date and time
temperature	Integer	temp for Temperature
address	Integer	To get the vehicle location
Lat	String	To get latitude of the site
Lng	String	To get longitude of the site

6.Temperature Deviation

Get the temperature deviation for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getTemperatureReport?

HTTP Method： GET

Input Parameters： Vehicleid, fromDate, fromTime, toTime, toDate, interval, fromDateUTC, toDateUTC

Parameters

Name	Type	Required	Default Value	Desc
Vehicleid	String	Yes	-	For get vehicle ID
fromDate	Date	Yes	-	used to get the date
fromTime	long	Yes	-	fromTime is used to get time
toDate	Date	Yes	-	toDate is used to get date
totime	long	Yes	-	toTime is used to get time
interval	long	Yes	-	used to get time interval
fromDateUTC	Date	Yes	-	toTimeUtc is used to get time
toDateUTC	Date	Yes	-	toTimeUtc is used to get time

Url Example:

http://domainname/getTemperatureReport?vehicleId=XYZ&fromDate=2022-12-23&fromTime=0:0:00&toDate=2022-12-23&toTime=14:44:00&interval=-1&fromDateUTC=1671733800000&toDateUTC=1671786840000

Response:

Field	Type	Description
data	String	To getting the date and time
temperature	Integer	temp for Temperature
address	Integer	To get the vehicle location
Lat	String	To get latitude of the site
Lng	String	To get longitude of the site

7.Radio frequency identification report

Get the radio frequency identification report for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getRfidReport

HTTP Method： GET

Input Parameters： Vehicleid, fromDate, fromTime, toTime, toDate, fromDateUTC, toDateUTC

Parameters

Name	Type	Required	Default Value	Desc
Vehicleid	String	Yes	-	For get vehicle ID
fromDate	Date	Yes	-	used to get the date
fromTime	long	Yes	-	fromTime is used to get time
toDate	Date	Yes	-	toDate is used to get date
totime	long	Yes	-	toTime is used to get time
fromDateUTC	Date	Yes	-	toTimeUtc is used to get time
toDateUTC	Date	Yes	-	toTimeUtc is used to get time

Url Example:

http://domainname/getTemperatureReport?vehicleId=XYZ&fromDate=2022-12-23&fromTime=0:0:00&toDate=2022-12-23&toTime=14:44:00&interval=-1&fromDateUTC=1671733800000&toDateUTC=1671786840000

Response:

Field	Type	Description
gd	String
fromTime	long	temp for Temperature
toTime	long	fromtime to get time
address	Integer	To get the vehicle location
Lat	String	To get latitude of the site
Lng	String	To get longitude of the site

8.Radio Frequency Identification Tag Report

Get the radio frequency identification report tag for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getRfidReportNew

HTTP Method： GET

Input Parameters： Vehicleid, fromDate, fromTime, toTime, toDate, fromDateUTC, toDateUTC

Parameters

Name	Type	Required	Default Value	Desc
Vehicleid	String	Yes	-	For get vehicle ID
fromDate	Date	Yes	-	used to get the date
fromTime	long	Yes	-	fromTime is used to get time
toDate	Date	Yes	-	toDate is used to get date
totime	long	Yes	-	toTime is used to get time
fromDateUTC	Date	Yes	-	toTimeUtc is used to get time
toDateUTC	Date	Yes	-	toTimeUtc is used to get time

Url Example:

http://domainname/getRfidReportNew?vehicleId=XYZ&fromDate=2022-12-24&fromTime=0:0:00&toDate=2022-12-24&toTime=10:12:00&fromDateUTC=1671820200000&toDateUTC=1671856920000

Response:

Field	Type	Description
dateTime	String	To get date and time
employeeId	Integer	To get the employee id
tagNo	Integer	To get tag number
address	String	To get the vehicle location
employeeName	String	To get employee name
mobile	Integer	To get mobile number
dept	String	To get the department
Lat	String	To get latitude of the site
Lng	String	To get longitude of the site

9.Protocol Report - DeviceData

Get the protocol report of device data for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getFuelRawDataLog?

HTTP Method： GET

Input Parameters： Vehicleid, fromTimeUTC, toTimeUTC

Parameters

Name	Type	Required	Default Value	Desc
Vehicleid	String	Yes	-	For get vehicle ID
fromTimeUTC	long	Yes	-	fromTime is used to get time
totimeUTC	long	Yes	-	toTime is used to get time

Url Example:

http://domainname/getFuelRawDataLog?vehicleId=XYZ&fromTimeUtc=1671820200000&toTimeUtc=1671864315000

Response:

Field	Type	Description
SystemTime	HH:mm:ss	To get the system time
SystemTime	yyyy-mm-dd	To get the system date
devicedataTime	HH:mm:ss	To get the device data time
deviceOdoMeter	-	To get the odometer reading
deviceMsg	String	To get msg
protocolType	-	-
validpacket	-	-

10.Protocol Report - DataConsumption

Get the protocol report of data consumption for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getDeviceDataAnalytics

HTTP Method： GET

Input Parameters： Vehicleid, fromDate, toDate

Parameters

Name	Type	Required	Default Value	Desc
Vehicleid	String	Yes	-	For get vehicle ID
fromDate	yyyy-mm-dd	Yes	-	fromdate used get the date
toDate	yyyy-mm-dd	Yes	-	toDate is used to get date

Url Example:

http://domainname/getDeviceDataAnalytics?vehicleId=XYZ&fromDate=2022-12-12&toDate=2022-12-18

Response:

Field	Type	Description
deviceModel	-	To get the device model
Date	yyyy-mm-dd	To get the time
dataUsage	-	To get the data usage

11.Consolidated Fuel Theft Report

Get the history of specific vehicle for checking the fuel theft for the given date and time range with fuel method. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getFuelReports

HTTP Method： GET

Input Parameters： groupId, month, year, fuelMethod

Parameters

Name	Type	Required	Default Value	Desc
groupId	String	Yes	-	For get vehicle ID
month	Integer	Yes	-	To get month
year	Integer	Yes	-	toDate is used to get date
fuelMethod	String	Yes	-	toDate is used to get date

Url Example:

http://domainname/getFuelReports?groupId=DEMO:Fcode&month=12&year=2022&fuelMethod=DROP

Response:

Field	Type	Description
position	string	To get the vehicle position
fuel	Float	For future use
shortName	String	To get vehicle name
totalfuel	Float	To get the total fuel level

12.Consolidated Fuel report

Get the consolidated fuel report the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getConReport

HTTP Method： GET

Input Parameters：groupName, date, ShiftTime

Parameters

Name	Type	Required	Default Value	Desc
groupName	String	Yes	-	For get groupname
date	dddd-mm-dd	Yes	-	To get Date
shiftTime	Integer	Yes	-	To get shiftTime

Url Example:

http://domainname/getConsolidatedFuelReport?groupName=DEMO:Fcode&date=2022-12-25

Response:

Field	Type	Description
vehicleName	string	To get the vehicle name
vehicleMode	String	To check the mode
vehicleModel	String	To get the vehicle model
fuelsensor	Array	To check the fuel level
fueltheft	Float	To detect fuel theft
fuelConsumption	Float	To find consumption of fuel
startKms	Float	To get the start kms value
endKms	Float	To get the end kms value
kmpl	Float	To check litre of fuel for km
litperHrs	Float	To check litre of fuel per hours
dist	Float	To check the distance
enginerunningHrs	Float	To check the running hours of vehicle
ignitionHrs	-	To check ignition time
secondaryEngineduration	-	Duration of engine
engineIdleHrs	-	To get the idle hrs of engine.
startAddress	String	to check start location
EndAddress	String	to check end location
driverName	String	To get driver name
driveMobileNo	String	To get the mobile number
startfuel	Float	Starting level of fuel
endfuel	Float	end level of fuel
fuelfilling		fuel filled
fuelbalance		to check fuel balance
fueltheft	Float	To show fuel theft data
litsPerHrs	Integer	To check the litre of fuel per hour

13.Dashboard

This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getSitewiseVehicleCount?

HTTP Method： GET

Input Parameters： GroupId

Parameters

Name	Type	Required	Default Value	Desc
groupId	String	Yes	-	For get group ID

Url Example:

http://domainname/getSitewiseVehicleCount?groupId=DEMO:Fcode

Response:

Field	Type	Description
geoFence	String	To get the site
getvehicles	String	To get the vehicleId

14.Consolidated Report

Get the history of specific vehicle's consolidated report for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/v2/getVehicleConsolidatedReport

HTTP Method： GET

Input Parameters：group, FromDate, fromTime, toDate, toTime, toDateUTC, fromDatetc

Parameters

Name	Type	Required	Default Value	Desc
group	String	yes	-	To get the group
fromDate	yyyy-mm-dd	Yes	-	fromdate is used to start date
toDate	yyyy-mm-dd	Yes	-	toDate is used to get endDate
fromtime	long	Yes	-	fromTime is used to get start time
totime	long	Yes	-	toTime is used to get end time
fromDateUTC	yyyy-mm-dd	Yes	-	fromDateUtc is used to start date
toDateUTC	yyyy-mm-dd	Yes	-	toDateUTC is used to get endDate

Url Example:

http://domainname/v2/getVehicleConsolidatedReport?group=OTTO:SMP&fromDate=2022-12-25&fromTime=0:0:0&toDate=2022-12-25&toTime=23:59:59&fromDateUTC=1671906600000&toDateUTC=1671992999000

Response:

Field	Type	Description
vehicleName	HH:mm:ss	To get the system time
vehicleMode	yyyy-mm-dd	To get the system date
totalTriplength	HH:mm:ss	To get the device data time
totalmovingtime	-	To get the odometer reading
totalParkedTime	String	To get msg
totalidletime	Long	idle time
topspeed	String	what was the average speed
averagespeed	String	what was the average speed
starttime	Long	To get the start time
endtime	Long	To get the end time
duration	String	Duration in milliseconds
address	String	To get the vehicle location
tripdistance	String	Total time for the trip

15.Consolidated site & Location

Get the site and location of the specific vehicle for the given time.

URL：

http://domainname/getConsolidatedSiteLocation?

HTTP Method： GET

Input Parameters： groupId, fromTimeUTC, toTimeUTc

Parameters

Name	Type	Required	Default Value	Desc
groupId	String	Yes	-	For get vehicle ID
fromTimeUTC	long	Yes	-	fromTime is used to get start time
totimeUTC	long	Yes	-	toTime is used to get end time

Url Example:

http://domainname/getConsolidatedSiteLocation?groupId=DEMO:Fcode&fromTimeUtc=1671906600000&toTimeUtc=1671992999000

Response:

Field	Type	Description
address	string	To get the vehicle location
state	Number	Vehicle status Parked, Idle, over speed,Location Entry, Location Exit, Site Entry, Site Exit
vehiclename	String	To get the vehicle name
Starttime	Long	To get the start time

16.Consolidated OverSpeed

Get the specific vehicle to know the overspeed of the vehicle for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getOverSpeedReport

HTTP Method： GET

Input Parameters: fromDatetc, toDateUtc, groupname

Parameters

Name	Type	Required	Default Value	Desc
groupName	String	yes	-	To get the group
fromDateUTC	yyyy-mm-dd	Yes	-	fromdate is used to start date
toDateutc	yyyy-mm-dd	Yes	-	toDate is used to get endDate

Url Example:

http://domainname/getOverSpeedReport?fromDateUTC=1671906600000&toDateUTC=1671992999000&groupName=DEMO:Fcode

Response:

Field	Type	Description
vehicleName	HH:mm:ss	To get the system time
shortName	String	To get the vehicle name
Speedlimit	Long	To get the Speed limit of vehicle
starttime	Long	To get the Starttime
endtime	Long	To get the end time

17.Consolidated stoppage

Get the history of specific vehicle stoppage time for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getStoppageReport

HTTP Method： GET

Input Parameters: fromDateUtc, toDateUtc, groupName

Parameters

Name	Type	Required	Default Value	Desc
groupName	String	yes	-	To get the group
fromDateUTC	yyyy-mm-dd	Yes	-	fromdate is used to start date
toDateutc	yyyy-mm-dd	Yes	-	toDate is used to get endDate

Url Example:

http://domainname/getStoppageReport?fromDateUTC=1671993000000&toDateUTC=1672079399000&groupName=DEMO:Fcode

Response:

Field	Type	Description
longitude	String	To get the location
latitude	String	To get the location
stoppageTime	Integer	To check the stoppage time
address	String	To get the location
error	String	To showing the errors
shorName	String	To get the vehicle name
starttime	Long	To get the Starttime
endtime	Long	To get the end time

18.Consolidated Site Report

Get the site report for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getConsolidatedSiteReport

HTTP Method： GET

Input Parameters: fromTimeUTC, totimeUTC, groupId, orgId

Parameters

Name	Type	Required	Default Value	Desc
groupId	String	yes	-	To get the group Id
orgId	String	yes	-	To get the Id
fromTimeUTC	long	Yes	-	fromTimeUTC is used to start time
toTimeUTC	long	Yes	-	toTimeUTC is used to get end Time

Url Example:

http://domainname/getConsolidatedSiteReport?vehicle=&siteName=&fromTimeUtc=1671993000000&toTimeUtc=1672079399000&groupId=DEMO:Fcode&orgId=OTTO

Response:

Field	Type	Description
sitelist	Array	To get the site list.
getDetails	Array	To get the vehicle detail
hist	Array	To check the site,vehicleid,time

19.Tollgate Report

Get the Tollgate report for the given date and time range. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getTollGateReport

HTTP Method： GET

Input Parameters: fromTimeUTC, totimeUTC, group

Parameters

Name	Type	Required	Default Value	Desc
group	String	yes	-	To get the group Id
fromTimeUTC	long	Yes	-	fromTimeUTC is used to start time
toTimeUTC	long	Yes	-	toTimeUTC is used to get end Time

Url Example:

http://domainname/getTollgateReport?group=OTTO:SMP&fromTimeUtc=1671993000000&toTimeUtc=1672079399000

Response:

Field	Type	Description
shorName	String	To get the vehicle name
tollGateName	String	To get the tollname
starttime	Long	To get the Starttime
toTime	Long	To get the end time
Lat	String	To get latitude of the site
Lng	String	To get longitude of the site
address	String	to get the vehicle location
time	yyyy-mm-dd & HH:mm:ss	To get the time and date
error	String	To give the error message

20.Travel Summary Report

Get the Tollgate report for the given date and time range.this used to show the status of vehicle to be idle or running, or stoppage. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getTravelSummaryReport

HTTP Method： GET

Input Parameters: fromDateUTC, toDateUTC, fromDate, toDate, groupId

Parameters

Name	Type	Required	Default Value	Desc
groupid	String	yes	-	To get the group Id
fromDateUTC	yyyy-mm-dd	Yes	-	fromDateUTC is used to start Date
toDateUTC	yyyy-mm-dd	Yes	-	toDateUTC is used to get end Date
fromDate	yyyy-mm-dd	Yes	-	fromDate is used to start Date
toDate	yyyy-mm-dd	Yes	-	toDate is used to get end Date

Url Example:

http://domainname/getTravelSummaryReport?groupId=DEMO:Fcode&fromDate=2022-12-26&toDate=2022-12-26&fromDateUTC=1671993000000&toDateUTC=1672079399000

Response:

Field	Type	Description
CompanyName	String	To get the company name
branch	String	To get the brance name
address	String	to get the vehicle location
idle	Integer	To get he idle vehicles
running	Integer	To get the running time
stop	Integer	To get the stop status
vehicleName	String	Vehicles name
startLoc	String	The start location
endLoc	String	The end location
vehicleMode	String	To get the vehicle mode
distance	Float	To know the distance of vehicle
totalWrkHours	Integer	To show the total working hours
nodata	integer	To show the nodata status occurence
maxStoppage	Integer	To show maximum speed
noOfIdle	Integer	To show the idle occurence
averagespeed	Integer	average speed of vehicle
max	Integer	Maximum speed
overspeedcount	Integer	count of overspeed for specific vehicles
alert	String	To show alert
error	String	To show error message

21.Site Stoppage Alert Report

Get the alert for the stoppage vehicle.This api is occur after getvehiclelocation api. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getSiteStoppageAlertReport

HTTP Method： GET

Input Parameters: fromTimeUTC, toTimeUTC, groupId

Parameters

Name	Type	Required	Default Value	Desc
fromTimeUtc	long	yes	-	To get the start time
toTimeUtc	long	yes	-	To get the end time
groupid	String	yes	-	To get the group Id

Url Example:

http://domainname/getSiteStoppageAlertReport?groupId=DEMO:Fcode&fromTimeUtc=1671993000000&toTimeUtc=1672079399000

Response:

Field	Type	Description
deviceTime	long	To get the device time
hist	Array	To check the history of vehicle
siteName	String	To get the site name
stoppageDuration	Integer	To get the stoppage duration
shortName	String	To get the vehicle name

22.Executive summary report

Get the vehiclewise performance with the given time and date.

URL：

http://domainname/getExecutiveReport

HTTP Method： GET

Input Parameters: groupId, fromDate, toDate, vehicleId, shiftTime

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start Date
toDate	yyyy-mm-dd	yes	-	To get the end Date
groupid	String	yes	-	To get the group Id
vehicleid	String	yes	-	To get the vehicle Id
shiftTime	String	yes	-	To get shift time

Url Example:

http://domainname/getSiteStoppageAlertReport?groupId=DEMO:Fcode&fromTimeUtc=1671993000000&toTimeUtc=1672079399000

Response:

Field	Type	Description
deviceTime	long	To get the device time
hist	Array	To check the history of vehicle
siteName	String	To get the site name
stoppageDuration	Integer	To get the stoppage duration
shortName	String	To get the vehicle name

23.Executive summary report - Monthly Dist

Get the executive monthly report with the given month and year.this api is called after the getvehiclelocation api.

URL：

http://domainname/getExecutiveReportVehicleDistance

HTTP Method： GET

Input Parameters: groupId, month, year

Parameters

Name	Type	Required	Default Value	Desc
month	String	yes	-	To get the month
year	string	yes	-	To get the year
groupid	String	yes	-	To get the group Id

Url Example:

http://domainname/getExecutiveReportVehicleDistance?groupId=DEMO:Fcode&month=1&year=2023

Response:

Field	Type	Description
vehicleId	String	To get the vehicles id with group name.
shortName	String	To get the vehicle name.
vehicleMode	String	To get the vehicle modes.
distances	Float	To get the monthly distance.
totalDistance	Float	To get the Total distance
position	String	To get the vehicle's position

24.Daily Performance

Get the daily performance report with the given month and year.this api is called after the getvehiclelocation api.

URL：

http://domainname/getDailyDriverPerformance

HTTP Method： GET

Input Parameters: groupId, fromutcTime, toutcTime

Parameters

Name	Type	Required	Default Value	Desc
fromutcTime	String	yes	-	To get the from time.
toutcTime	string	yes	-	To get the to time.
groupid	String	yes	-	To get the group Id

Url Example:

http://domainname/getDailyDriverPerformance?groupId=DEMO:Fcode&fromUtcTime=1673116200000&toUtcTime=1673202599000

Response:

Field	Type	Description
month	String	To get the month
WeightedBreakAnalysis	Integer	To get the heavy break.
WeightedSpeedAnalysis	Integer	To get the over speed.
weightedShockAlarmAnalysis	Integer	To get the time of alarm.
WeightedAccelAnalysis	Integer	To get the acceleration
historySpeedAnalysis	Object	To get the history of speed analysis
historyShockAlarm	Object	To get the history of shock alarm

25.Monthly Performance

Get the daily performance report with the given month and year.this api is called after the getvehiclelocation api.

URL：

http://domainname/getOverallDriverPerformance

HTTP Method： GET

Input Parameters: groupId, month, year

Parameters

Name	Type	Required	Default Value	Desc
month	String	yes	-	To get the month
year	string	yes	-	To get the year
groupid	String	yes	-	To get the group Id

Url Example:

http://domainname/getOverallDriverPerformance?groupId=DEMO:Fcode&month=12&year=2022

Response:

Field	Type	Description
month	String	To get the month
WeightedBreakAnalysis	Integer	To get the heavy break.
WeightedSpeedAnalysis	Integer	To get the over speed.
weightedShockAlarmAnalysis	Integer	To get the time of alarm.
WeightedAccelAnalysis	Integer	To get the acceleration
historySpeedAnalysis	Object	To get the history of speed analysis
historyShockAlarm	Object	To get the history of shock alarm

26.Executive fuel report

Get the Executive report with the given Date.this api is called after the getvehiclelocation api.

URL：

http://domainname/getExecutiveFuelReport

HTTP Method： GET

Input Parameters: groupId, fromDate, toDate

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start date.
toDate	yyyy-mm-dd	yes	-	To get the end date
groupid	String	yes	-	To get the group Id

Url Example:

http://domainname/getExecutiveFuelReport?groupId=DEMO:Fcode&fromDate=2023-01-03&toDate=2023-01-09

Response:

Field	Type	Description
date	String	To get the Date.
vehicleName	String	To get the vehicle name.
vehicleId	String	To get the vehicleid
startFuelLevvel	Float	Starting level of fuel
endFuelLevel	Float	Ending level of fuel
fuelFills	Float	To get the fuel filled in vehicle.
fuelDrops	Float	To know the fuel theft.
fuelConsume	Float	To check the fuel consumption
distanceToday	Float	To get the distance travelled today.
milage	Float	to get the kilometers per litre.
totalPrimaryEngine	Float	To get the engine on hours.
ltrsphr	Float	To get the litres per hour

27.Monthyly Distance and Fuel Report

Get the distance and fuel month wise.this api is called after the getvehiclelocation api.

URL：

http://domainname/getExecutiveFuelReport

HTTP Method： GET

Input Parameters: groupId, month, year

Parameters

Name	Type	Required	Default Value	Desc
month	String	yes	-	To get the month
year	string	yes	-	To get the year
groupid	String	yes	-	To get the group Id

Url Example:

http://domainname/getMonthlyExecutiveDistanceAndFuel?groupId=DEMO:Fcode&month=1&year=2023

Response:

Field	Type	Description
vehicleiD	String	To get the vehicleid.
VehicleName	String	To get the vehicle name.
TotalDistance	Float	To get the total distance
totalFuelconsume	Float	To get the total fuel consumption.
totalKMPL	Float	To get the total kmpl.
totalLph	Float	To get the total ltph.
totalFuelFill	Float	To get the total fuel fills.
vehicleMode	String	To get the vehiclemode.
position	String	To get the vehicle location.
KMPL	Float	To get the kilometers per litre.
lph	Float	To get the litres per hour.
distance	Float	To get the distance.
date	yyyy-mm-dd	To get the current date
litres	Float	To get the litres count.
cumulativeVehicleLphData	Float	To get the total litresperhour per day.
cumulativeVehicleKmplData	Float	To get the total kmpl per day
cumulativeVehicleFuelFillData	Float	To get the fuelfill total per day
cumulativeVehicleFuelData	Float	To get the fuel total per day
cumulativeVehicleDistanceData	Float	To get the distance total per day

28.Fuel Analytics

Get the fuel anlytics with the given date and time. This api is called after the get vehicle location api.

URL：

http://domainname/getFuelDetailForMachinery

HTTP Method： GET

Input Parameters: vehicleid, fromDateTime, toDateTime

Parameters

Name	Type	Required	Default Value	Desc
fromDateTime	Long	yes	-	To get the start date and time.
toDateTime	Long	yes	-	To get the end date and time
vehicleid	String	yes	-	To get the group Id

Url Example:

http://domainname/getFuelDetailForMachinery?vehicleId=XYZ&fromDateTime=1673202600000&toDateTime=1673506342000

Response:

Field	Type	Description
date	yyyy-mm-dd	To get the date.
starttime	Long	To get the start time
time	Long	To get the time
pfuel	Float	To get the previous fuel
cfuel	Float	To get the current fuel
lt	Float	To get the litres per hour
odo	Float	To get the odometer reading
address	String	used to get the address
error	String	To show error message
fuelconsumption	Float	To get the fuel consumption
totalconsumption	Float	To get the total fuel consumption
startaddress	String	To get the start address
endaddress	String	To get the end address
lat	Float	To get the correct location
lng	Float	To get the correct location

29.Dispenser Report

Get the dispenser detail with the given date and fueldispenser value. This api is called after the get vehicle location api.

URL：

http://domainname/getExecutiveFuelReport

HTTP Method： GET

Input Parameters: groupidid, fromDate, toDate, fuelDispenser

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start date.
toDate	yyyy-mm-dd	yes	-	To get the end date.
groupid	String	yes	-	To get the group Id
fuelDispenser	String	yes	-	To get the tru or false value

Url Example:

http://domainname/getExecutiveFuelReport?groupId=DEMO:Fcode&fromDate=2023-01-09&toDate=2023-01-12&fuelDispenser=true

Response:

Field	Type	Description
date	yyyy-mm-dd	To get the date.
startfuelLevel	Float	To get the previous fuel
endfuelLevel	Float	To get the current fuel
fuelFills	Float	To get the fuel fill level.
fuelDispenser	Float	level of fuel dispenser
totalfuelDispensed	Float	Total level of fuel dispensed
error	String	To get the error message

30.Geofence fuel Report

This api is used to get the trip distance,running time,count of the trip with the given time, date and site deails.This api is called after the get vehicle location api.

URL：

http://domainname/getSiteTripFuelReport

HTTP Method： GET

Input Parameters: vehicleid, fromDate, toDate, fromTime, toTime, site1, site2, fromDateUTC, toDateUTC,language.

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start date.
toDate	yyyy-mm-dd	yes	-	To get the end date.
fromTime	Long	yes	-	To get the start time.
toTime	Long	yes	-	To get the end time.
fromDateUTC	Long	yes	-	To get the Date
toDateUTC	Long	yes	-	To get the Date
language	String	yes	-	To get the language.
site1,site2	Long	yes	-	To get the site detail.

Url Example:

http://domainname/getSiteTripFuelReport?vehicleId=XYZ&fromDate=2023-01-01&fromTime=0:0:00&toDate=2023-01-11&toTime=15:11:00&language=en&site1=All&site2=All&fromDateUTC=1672511400000&toDateUTC=1673430060000

Response:

Field	Type	Description
distance covered	Float	To get the distance covered by vehicle.
kmpl	Float	To check the kmpl.
tripcount	Integer	To get the trip count
singleTripDistance	Float	To get the trip distance.
runningtime	Float	To get the running time.
date	yyyy-mm-dd	To get the date.
startfuelLevel	Float	To get the previous fuel
endfuelLevel	Float	To get the current fuel
fuelFills	Float	To get the fuel fill level.

31.Fuel Raw Data

This uses 6 api's based on the sensors selected by the user. for sensor all option the below api's used for access data

URL:

HTTP Method： GET

1. getFuelRawDataAll?vehicleId=XYZ&fromTimeUtc=1675362600000&toTimeUtc=1675406105000&interval=&R=1200
2. getFuelDetailForAll?vehicleId=XYZ&fromDateTime=1675362600000&toDateTime=1675406105000

Parameters

Name	Type	Required	Default Value	Desc
fromTimeUTC	Long	yes	-	To get the start time.
toTimeUTC	Long	yes	-	To get the end time.
vehicleId	String	yes	-	To get the vehicleid.
Interval	Integer	yes	-	To give interval value.
R	Integer	yes	-	To get the .

sensor 1 is selected by the user these api's used:

1. getFuelRawData?vehicleId=XYZ&fromTimeUtc=1675362600000&toTimeUtc=1675406105000&interval=5&sensor=1&R=1200
2. getFuelDetailForMachinery?vehicleId=XYZ&fromDateTime=1675362600000&toDateTime=1675406105000&sensor=1

Parameters

Name	Type	Required	Default Value	Desc
fromTimeUTC	Long	yes	-	To get the start time.
toTimeUTC	Long	yes	-	To get the end time.
vehicleId	String	yes	-	To get the vehicleid.
Interval	Integer	yes	-	To give interval value.
R	Integer	yes	-	To get the .
sensor	Integer	yes	-	To ge the fuel level.

greater than one sensor seleted by the user these api's used:

1. getFuelRawData?vehicleId=XYZ&fromTimeUtc=1675362600000&toTimeUtc=1675406105000&interval=5&sensor=2&R=1200
2. getFuelDetailForMachinery?vehicleId=XYZ&fromDateTime=1675362600000&toDateTime=1675406105000&sensor=2

Parameters

Name	Type	Required	Default Value	Desc
fromTimeUTC	Long	yes	-	To get the start time.
toTimeUTC	Long	yes	-	To get the end time.
vehicleId	String	yes	-	To get the vehicleid.
Interval	Integer	yes	-	To give interval value.
R	Integer	yes	-	To get the .
sensor	Integer	yes	-	To ge the fuel level.

Url Example:

http://domainname/getFuelRawData?vehicleId=XYZ&fromTimeUtc=1672770600000&toTimeUtc=1673591827000&interval=5&zeroRecord=false&R=1200

Response:

Field	Type	Description
distance covered	Float	To get the distance covered by vehicle.
kmpl	Float	To check the kmpl.
tripcount	Integer	To get the trip count
singleTripDistance	Float	To get the trip distance.
runningtime	Float	To get the running time.
date	yyyy-mm-dd	To get the date.
startfuelLevel	Float	To get the previous fuel
endfuelLevel	Float	To get the current fuel
fuelFills	Float	To get the fuel fill level.

2.URL：

http://domainname/getFuelDetailForMachinery

HTTP Method： GET

Input Parameters: vehicleid, interval, zero record, fromTimeUTC, toTimeUTC,.

Parameters

Name	Type	Required	Default Value	Desc
fromDateTime	Long	yes	-	To get the start date and time.
toDateTime	Long	yes	-	To get the end date and time.
vehicleId	String	yes	-	To get the vehicleid.

Url Example:

http://domainname/vehicleId=XYZ&fromDateTime=1674930600000&toDateTime=1675312383000&sensor=1

Response:

Field	Type	Description
startTime	HH:mm:ss	To get the start time.
endTime	HH:mm:ss	To get the end time.
ignitionOnper	HH:mm:ss	To get the engine on hours.
startfuel	Float	To get the previous fuel.
endfuel	Float	To get the current fuel.
totalConsumption	Float	To get the total consumption fuel.
ltrphr	Float	To get the litres per hour.
fuelmileage	Float	To get the mileage value.
fuelconsume	Float	To get the fuel consumption.
fuelTheftBeta	Float	To get the fuel theft in litres.
startAddress	String	To get the start location.
endAddress	String	To get the end location.
startLng	Long	To get the start longitude.
endLng	Long	To get the endlongitude.
startlat	Long	To get the start latitude.
endlat	Long	To get the End latitude.
odo	Float	To get the odo reading.
error	String	To showing error message.

32.Vehicle Wise Fuel Report

This api is used to get the vehicle wise fuel report with the fuel consumption,distance,,fuel filling,engines status and theft in fuels. this api is called after the get vehicle location api.

URL：

http://domainname/getConsolidatedVehicleWise

HTTP Method： GET

Input Parameters: vehicleid, fromDate, toDate.

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start date.
toDate	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getConsolidatedVehicleWise?vehicleId=XYZ&fromDate=2023-01-12&toDate=2023-01-12

Response:

Field	Type	Description
fuelconsumption	Float	To get the fuel consumption value.
fuelTheft	Float	To know the theft in fuel.
fuelDispenser	Float	vehicle for fuel.
startKms	Integer	to get the starting kilometers.
endKms	Integer	To get the end kilometers.
dist	Float	To get the distance
kmpl	Float	To get the kmpl.
enginerunningHrs	HH:mm:ss	engine running hours
ignitionHrs	HH:mm:ss	To get the ignition hours.
SecondaryengineDuration	HH:mm:ss	The secocondary engine hours.
engineIdleHrs	HH:mm:ss	To get the idle hours of vehicle.
litperHr	Float	To get the litres per hour.
startfuel	Float	To get the previous fuel
endfuel	Float	To get the current fuel
fuelFilling	Float	To get the fuel fill level.

33.Vehicle Wise Intraday Fuel

This api is used to get the vehicle wise fuel report with the fuel consumption,distance,,fuel filling,engines status and theft in fuels with the intraday report. this api is called after the get vehicle location api.

URL：

http://domainname/getConsolidatedFuelReportBasedOnTime

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, sensor.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.
sensor	Integer	yes	-	To get the sensor count.

Url Example:

http://domainname/getConsolidatedFuelReportBasedOnTime?vehicleId=XYZ&fromDateUtc=1673461800000&toDateUtc=1673604396000&sensor=1

Response:

Field	Type	Description
vehicleId	String	To get the vehicle id.
vehicleMode	String	To get the vehicle modde
VehicleModel	String	To get the vehicle model.
startLoc	String	To get the startin location.
endLoc	String	To get the ending location
fuelconsumption	Float	To get the fuel consumption value.
fuelTheft	Float	To know the theft in fuel.
fuelDispenser	Float	vehicle for fuel.
startKms	Integer	to get the starting kilometers.
endKms	Integer	To get the end kilometers.
dist	Float	To get the distance
kmpl	Float	To get the kmpl.
enginerunningHrs	HH:mm:ss	engine running hours
ignitionHrs	HH:mm:ss	To get the ignition hours.
SecondaryengineDuration	HH:mm:ss	The secocondary engine hours.
engineIdleHrs	HH:mm:ss	To get the idle hours of vehicle.
litperHr	Float	To get the litres per hour.
startfuel	Float	To get the previous fuel
endfuel	Float	To get the current fuel
fuelFilling	Float	To get the fuel fill level.

34.Fuel Notification Report

This api used to get the fuel filling,drops and excess consumpion notification with the given Date.This api is called after the get vehicle location api.

URL：

http://domainname/getFuelNotificationReport

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, sensor.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getFuelNotificationReport?vehicleId=XYZ&fromDateUTC=1673461800000&toDateUTC=1673607142000

Response:

Field	Type	Description
litres	Float	To get the litres of fuel consumed.
shortName	String	To get the vehicle name.
lat	Float	To get the location.
lng	Float	To get the vehicle location.
lat	Float	To get the vehicle location
Date	yyyy-mm-dd	For getting date.

35.Movement Report

This takes the value that is filtered by position "M" in the api.It is used to get the movement report.

URL：

http://domainname/getVehicleHistory

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, interval.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.
interval	Integer	yes	-	To get the interval time.

Url Example:

http://domainname/getVehicleHistory?vehicleId=XYZ&interval=&fromDateUTC=1673893800000&toDateUTC=1673928640000

Response:

Field	Type	Description
date	yyyy-mm-dd & HH:mm:ss	To get the date and time.
speed	Float	To get the speed.
latitude	Float	To get the address occurately.
longitude	Float	To get the location occurately.
address	String	To get the location.
tmpDistance	Float	To get the distance.
distanceCovered	Float	To get the distance covered.
odoDistance	Float	Odometer reading.
Topspeed	-	It show the top speed with time
TotalDistance	Float	To get the total distance.
total running time	HH:mm:ss	To get the total hours
total parked time	HH:mm:ss	To get the total parked time.
Total idle Time	HH:mm:ss	To get the total idle time.
No.Of.Parking	Integer	To get the parking count.
No data time	HH:mm:ss	To get the no data time.

36.Overspeed Report

This takes the value comes from 'overspeedList' in the getvehicleHistory api.It is used to get the overspeedvehicle report.

URL：

http://domainname/getVehicleHistory

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, interval.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.
interval	Integer	yes	-	To get the interval time.

Url Example:

http://domainname/getVehicleHistory?vehicleId=XYZ&interval=&fromDateUTC=1673893800000&toDateUTC=1673928640000

Response:

Field	Type	Description
starTime	yyyy-mm-dd & HH:mm:ss	To get the start date and time.
endTime	yyyy-mm-dd & HH:mm:ss	To get the end date and time.
overSpeed	Float	To get the over speed.
latitude	Float	To get the address occurately.
longitude	Float	To get the location occurately.
tripDistance	Float	To get the trip distance.
Topspeed	-	It show the top speed with time
TotalDistance	Float	To get the total distance.
total running time	HH:mm:ss	To get the total hours
total parked time	HH:mm:ss	To get the total parked time.
Total idle Time	HH:mm:ss	To get the total idle time.
No.Of.Parking	Integer	To get the parking count.
No data time	HH:mm:ss	To get the no data time.

37.Parked Report

This takes the value that is filtered by position "P" in the api.It is used to get the parked vehicle report.

URL：

http://domainname/getVehicleHistory

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, interval.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.
interval	Integer	yes	-	To get the interval time.

Url Example:

http://domainname/getVehicleHistory?vehicleId=XYZ&interval=&fromDateUTC=1673893800000&toDateUTC=1673928640000

Response:

Field	Type	Description
startParkeddate	yyyy-mm-dd & HH:mm:ss	To get the start date and time.
endParkeddate	yyyy-mm-dd & HH:mm:ss	To get the end date and time.
parkedTime	Integer	To get the parked timing.
address	String	To get the location.
latitude	Float	To get the location occurately.
longitude	Float	To get the location occurately.
Topspeed	-	It show the top speed with time
TotalDistance	Float	To get the total distance.
total running time	HH:mm:ss	To get the total hours
total parked time	HH:mm:ss	To get the total parked time.
Total idle Time	HH:mm:ss	To get the total idle time.
No.Of.Parking	Integer	To get the parking count.
No data time	HH:mm:ss	To get the no data time.

38.Idle Report

This takes the value that is filtered by position "S" in the getvehiclehistory api.It is used to get the idle vehicles report.

URL：

http://domainname/getVehicleHistory

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, interval.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.
interval	Integer	yes	-	To get the interval time.

Url Example:

http://domainname/getVehicleHistory?vehicleId=XYZ&interval=&fromDateUTC=1673893800000&toDateUTC=1673928640000

Response:

Field	Type	Description
date	yyyy-mm-dd & HH:mm:ss	To get the start date and time.
idleEnddate	yyyy-mm-dd & HH:mm:ss	To get the end date and time.
idleTime	Integer	To get the idle timing.
address	String	To get the location.
latitude	Float	To get the location occurately.
longitude	Float	To get the location occurately.
Topspeed	-	It show the top speed with time
TotalDistance	Float	To get the total distance.
total running time	HH:mm:ss	To get the total hours
total parked time	HH:mm:ss	To get the total parked time.
Total idle Time	HH:mm:ss	To get the total idle time.
No.Of.Parking	Integer	To get the parking count.
No data time	HH:mm:ss	To get the no data time.

39.Ignition Report

This api is used to get the ignition status with the given date and time.

URL：

http://domainname/getPrimaryEngineReport

HTTP Method： GET

Input Parameters: vehicleid, fromDateTime, toDateTime.

Parameters

Name	Type	Required	Default Value	Desc
fromDateTime	yyyy-mm-dd	yes	-	To get the start date.
toDateTime	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getPrimaryEngineReport?vehicleId=XYZ&fromDateTime=1673893800000&toDateTime=1673950728000

Response:

Field	Type	Description
dateTime	yyyy-mm-dd & HH:mm:ss	To get the date and time.
Ignitionstatus	String	To get the ON and OFF status.
address	String	To get the location.
latitude	Float	To get the location occurately.
longitude	Float	To get the location occurately.
Topspeed	-	It show the top speed with time
TotalDistance	Float	To get the total distance.
total running time	HH:mm:ss	To get the total hours
total parked time	HH:mm:ss	To get the total parked time.
Total idle Time	HH:mm:ss	To get the total idle time.
No.Of.Parking	Integer	To get the parking count.
No data time	HH:mm:ss	To get the no data time.

40.Site Trip

This api is used to get the site trip detail with the given time, date, language and site detail.

URL：

http://domainname/getSiteTripReport

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, fromdate, todate, fromTime, toTime, site1, site2, language.

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start date.
toDate	yyyy-mm-dd	yes	-	To get the end date.
fromDateUTC	Long	yes	-	To get the start date.
toDateUTC	Long	yes	-	To get the end date.
language	String	yes	-	To get the language used.
site	String	yes	-	To get the site detail.
fromTime	HH:mm:ss	yes	-	To get the start Time.
toTime	HH:mm:ss	yes	-	To get the end Time.
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getSiteTripReport?vehicleId=XYZ&fromDate=2023-01-16&fromTime=0:0:00&toDate=2023-01-16&toTime=23:59:00&language=en&site1=All&site2=All&fromDateUTC=1673807400000&toDateUTC=1673893740000

Response:

Field	Type	Description
state	Integer	To get the end and start location.
startTime	HH:mm:ss	To get the start time.
endtime	HH:mm:ss	To get the end time.
detentionTime	HH:mm:ss	To get the trip duration.
distanceCovered	Float	To get the distance.
runningTime	HH:mm:ss	To get the running hours.
stoppageTime	HH:mm:ss	To get the stoppage hours.
avgSpeed	Integer	To get the average speed.
tripcount	Integer	To get the trip count.
singleTripDistance	Integer	To get the single trip distance.
speedViolation	Integer	To get the speed violation.

41.Trip Summary

This api is used to get the trip summary detail with the given time, date and vehicleid.

URL：

http://domainname/getTripSummary

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, fromdate, todate, fromTime, toTime.

Parameters

Name	Type	Required	Default Value	Desc
fromDate	yyyy-mm-dd	yes	-	To get the start date.
toDate	yyyy-mm-dd	yes	-	To get the end date.
fromDateUTC	Long	yes	-	To get the start date.
toDateUTC	Long	yes	-	To get the end date.
fromTime	HH:mm:ss	yes	-	To get the start Time.
toTime	HH:mm:ss	yes	-	To get the end Time.
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getTripSummary?vehicleId=XYZ&fromDate=2023-01-17&fromTime=00:00:00&toDate=2023-01-18&toTime=10:04:04&fromDateUTC=00:00:00&toDateUTC=1674016444000

Response:

Field	Type	Description
fromTime	HH:mm:ss	To get the start time.
toTime	HH:mm:ss	To get the end time.
lastLocation	String	To get the last location.
vehicleName	String	To get the vehicle name.
vehTripName	String	To get the vehicle trip name.
vehicleId	String	To get the vehicle Id.
kmpl	Float	To get the kmpl value.
totalTripLength	Float.	To get the total trip length.
totalMovingTime	HH:mm:ss	To get the total moving hours.
initialFuel	Float	To get the initial fuel level.
fuelFillcount	Float	To get the fuel fill count.
totalidleTime	HH:mm:ss	To get the total idle time.
finalFuel	Float	To get the current fuel.
moveCount	Integer	To get the move count.
totalParkingTime	HH:mm:ss	To get the total parking time.
totalFuelFilled	Float	To get the total fuel filled.
parkcount	Integer	To get the park count.
totalNoDataTime	HH:mm:ss	To get the total no data hours.
totalfuelConsume	Float	To get the total fule consume.
idleCount	Integer	To get the idle counting.
historyConsolidate	Object	To get the detail about the trip.

42.No Data

This takes the value that is filtered by position "U" in the getvehiclehistory api.It is used to get the nodata vehicles report.

URL：

http://domainname/getVehicleHistory

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC, interval.

Parameters

Name	Type	Required	Default Value	Desc
fromDateUTC	yyyy-mm-dd	yes	-	To get the start date.
toDateUTC	yyyy-mm-dd	yes	-	To get the end date.
vehicleId	String	yes	-	To get the vehicleId.
interval	Integer	yes	-	To get the interval time.

Url Example:

http://domainname/getVehicleHistory?vehicleId=XYZ&interval=&fromDateUTC=1673893800000&toDateUTC=1673928640000

Response:

Field	Type	Description
date	yyyy-mm-dd & HH:mm:ss	To get the date and time.
noDataTime	HH:mm:ss	To get the date and time of nodata.
address	String	To get the location.
latitude	Float	To get the location occurately.
longitude	Float	To get the location occurately.
vehicleGroup	String	To get the group name.
Vehiclename	String	To ge the vehicle name
Topspeed	-	It show the top speed with time
TotalDistance	Float	To get the total distance.
total running time	HH:mm:ss	To get the total hours
total parked time	HH:mm:ss	To get the total parked time.
Total idle Time	HH:mm:ss	To get the total idle time.
No.Of.Parking	Integer	To get the parking count.
No data time	HH:mm:ss	To get the no data time.

43.Route Deviation

This takes the value that is filtered by position "U" in the getvehiclehistory api.It is used to get the nodata vehicles report.

URL：

http://domainname/getRouteDeviationData

HTTP Method： GET

Input Parameters: vehicleid, fromTimeUTC, toTimeUTC.

Parameters

Name	Type	Required	Default Value	Desc
fromTimeUTC	HH:mm:ss	yes	-	To get the start Time.
toTimeUTC	HH:mm:ss	yes	-	To get the end time.
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getRouteDeviationData?vehicleId=XYZ&fromTimeUtc=1673980200000&toTimeUtc=1674031637000

Response:

Field	Type	Description
routeName	String	To get the route name.
deviceTime	HH:mm:ss	To get the device time.
distance	Float	To get the distance.
latitude	Float	To get the location occurately.
longitude	Float	To get the location occurately.
vehicleGroup	String	To get the group name.
Vehiclename	String	To ge the vehicle name

44.Single Track

This API is to track single vehicle. This API should be fired after firing getVehicleLocations API. Because the getVehicleLocations API has the mapping between vehicleName and vehicleId. For this (getSelectedVehicleLocation) API vehicle ID is the key input.

URL：

http://domainname/getSelectedVehicleLocation

HTTP Method： GET

Input Parameters: vehicleid, track, maps.

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	yes	-	To get the vehicleId.
track	String	yes	-	To get the tracking detail.
maps	String	yes	-	To get the map based on the maps value.

Url Example:

http://domainname/getSelectedVehicleLocation?vehicleId=XYZ&track=single&maps=single

Response:

Field	Type	Description
shortName	String	To get the vehicle name.
expectedFuelMileage	Float	To get the fuel mileage.
nTankSize	Float	To get the tank size.
overSpeedLimit	Float	To get the overspeed.
regno	Integer	To get the register number.
devicevolt	Float	To get the device voltage.
date	yyyy-mm-dd	To get the date.
ododistance	Float	To get the odo distance.
position	String	To get the vehicles position.
idleTime	String	To get the idle time.
parkedTime	HH:mm:ss	To get the parked time.
movingTime	HH:mm:ss	To get the moving time.
noDataTime	HH:mm:ss	To get the no data time.
speed	Float	To get the speed of the vehicle.
gsmLevel
address	String	To get the location of the vehicle.
latitude	Float	To get the location occurately.
longitude	Float	To get the location occcuately.

45.Multi Track

This API is to track Multi vehicles. This uses both getSelectedVehicleLocation and getvehiclelocations.

1.URL：

http://domainname/getSelectedVehicleLocation

HTTP Method： GET

Input Parameters: vehicleid.

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	yes	-	To get the vehicleId.

Url Example:

http://domainname/getSelectedVehicleLocation?vehicleId=XYZ&track=single&maps=single

Response:

Field	Type	Description
shortName	String	To get the vehicle name.
group	String	To get the group.

2.URL：

http://domainname/getVehicleLocations

HTTP Method： GET

Url Example:

http://domainname/getVehicleLocations

Response:

Field	Type	Description
shortName	String	To get the vehicle name.
group	String	To get the group.
vehicleId	String	To get the vehicleId.
ododistance	Float	odometer reading.
speed	Float	To get the vehicle speed.
address	String	To get the address.

46.History

This API is used to find the history of the vehicle for speed,distance,fuel and time. This uses getSelectedVehicleLocation, getvehiclelocations, storeOrgValues/mapHistory and storeOrgValues.

1.URL：

http://domainname/getVehicleHistory

HTTP Method： GET

Input Parameters: vehicleid, fromDateUTC, toDateUTC.

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	yes	-	To get the vehicleId.
fromDateUTC	Long	yes	-	To get the from date.
toDateUTC	Long	yes	-	To get the end date.

Url Example:

http://domainname/getVehicleHistory?vehicleId=XYZ&fromDateUTC=1674613849963&toDateUTC=1674620989963

Response:

Field	Type	Description
shortName	String	To get the vehicle name.
group	String	To get the group.
Date	yyyy-mm-dd	To get the date.
speed	Float	To get the speed.
address	String	To get the location.
direction	String	To get the direction
latitude	Float	To get the latitude.
longitude	Float	To get the latitude.
distancecovered	Float	To get the distance covered.
odoDistance	Float	odo meter reading.
fuelLitre	Float	To get the fuel level
ignitionStatus	String	To get the ignition status.
regNo	String	To get the vehicle name.
overspeedLimit	Float	To get the over speed limit.

2.URL：

http://domainname/getVehicleLocations

HTTP Method： GET

Url Example:

http://domainname/getVehicleLocations

Response:

Field	Type	Description
shortName	String	To get the vehicle name.
group	String	To get the group.
vehicleId	String	To get the vehicleId.
ododistance	Float	odometer reading.
speed	Float	To get the vehicle speed.
address	String	To get the address.
ntanksize	Float	To get the tank size.
fuelLitre	Float	To get the current fuel.

3.URL：

http://domainname/storeOrgValues

HTTP Method： GET

Input Parameter: orgId.

Parameter

Name	Type	Required	Default Value	Desc
orgId	String	yes	-	To get the organisation Id.

Url Example:

http://domainname/storeOrgValues/val?orgId%5B%5D=CATU

Response:

Field	Type	Description
routeNames	String	To get the route names.

4.URL：

http://domainname/storeOrgValues/mapHistory

HTTP Method： GET

Input Parameter: orgId.

Parameter

Name	Type	Required	Default Value	Desc
organId	String	yes	-	To get the organisation Id.
mapRoute	String	yes	-	To get the routes.

Url Example:

http://domainname/storeOrgValues/mapHistory?maproute=testing+check&organId%5B%5D=CATU

Response:

Field	Type	Description
latitude	String	To get the route occurately.
longitude	String	To get the route occurately.

47.Add sites/geofence

This api is used to put the site or geofence based on the oraganisation and organisation id and type.

URL：

http://domainname/v2/viewSiteV2

HTTP Method： GET

Url Example:

http://domainname/v2/viewSiteV2

Response:

Field	Type	Description
siteName	string	To get the site name.
siteType	String	To get the site Type.
orgId	String	To get the organisation id.
sitePlanTime	Integer	To get the site plan time.

48.Alarm Report

This api is used to give the alerts about the battery and type of alert within time and date. This API should be fired after firing getVehicleLocations API. Because the first API has the mapping between vehicleName and vehicleId. For this API vehicleID is the input.

URL：

http://domainname/getAlarmReport

HTTP Method： GET

Input Parameters: fromDateUtc, toDateUtc, vehicleId, fromDate, to Date, fromTime, toTime.

Parameters

Name	Type	Required	Default Value	Desc
vehicleId	String	yes	-	To get the vehicleId.
fromDateUTC	yyyy-mm-dd	Yes	-	fromdate is used to start date
toDateutc	yyyy-mm-dd	Yes	-	toDate is used to get endDate
fromDate	String	Yes	-	To get the start datet.
toDate	String	Yes	-	to get the end date.
fromTime	String	Yes	00:00:00	to get the start time(24 hours format).
toTime	String	Yes	23:59:59	To get the endtime(24 hoursformat).

Url Example:

http://domainname/getAlarmReport?vehicleId=XYZ&fromDate=2023-03-15&fromTime=0:0:00&toDate=2023-03-15&toTime=14:54:00&fromDateUTC=1678818600000&toDateUTC=1678872240000

Response:

Field	Type	Description
longitude	String	To get the location
latitude	String	To get the location
alarmTime	HH:mm:ss/dd-MM-yyyy	To get the alarm time with date.
address	String	To get the location
alarmType	String	To get the alarm type.

49.Edit Notification

This api is used to get the notification.

URL：

http://domainname/getUserNotification

HTTP Method： GET

Url Example:

http://domainname/getUserNotification

Response:

Field	Type	Description
Notification	String	To get the notification messages.

50.Get Url

This api is used to get the url for sharing the vehicle details to others.

URL：

http://domainname/getVehicleLocations

HTTP Method： GET

Url Example:

http://domainname/getVehicleLocations

Response:

Field	Type	Description
group	String	To get the group Name.

51.Get Apikey

This api is used to get the url for sharing the vehicle details to others.

URL：

http://domainname/getApiKey

Input Parameters: validdays,Time.

Parameters

Name	Type	Required	Default Value	Desc
validDays	String	yes	-	To give the validity for apikey.
time	Float	yes	-	To give the valid time.

HTTP Method： GET

Url Example:

http://domainname/getApiKey?validDays=12&time=1678948901

Response:

Field	Type	Description
apikey	String	To get the apikey with validity.

52.Geofence Shift Report

This api is used to get the shift details based on the organisation name and selected date.

1.URL：

http://domainname/getOrgShiftsBasedOnOrg

Input Parameters: orgId.

Parameters

Name	Type	Required	Default Value	Desc
orgId	String	yes	-	To get the organisation Id.

HTTP Method： GET

Url Example:

http://domainname/getOrgShiftsBasedOnOrg?orgId=MSS

Response:

Field	Type	Description
shiftName	String	To get the shift Name.
startTime	HH:mm	To get the start Time.
endTime	HH:mm	To get the end Time.

This api is used to get the shift details based on the organisation name and selected date.

2.URL：

http://domainname/getOrgShiftReportForUser

Input Parameters: orgId, shiftName, fromTimeUTC, toTimeUtc.

Parameters

Name	Type	Required	Default Value	Desc
orgId	String	yes	-	To get the organisation Id.
shiftName	String	yes	-	To get the shift Name.
fromTimeUtc	Float	yes	-	To get the from time..
toTimeutc	Float	yes	-	To get the end time.

HTTP Method： GET

Url Example:

http://domainname/getOrgShiftReportForUser

Response:

Field	Type	Description
vehicleName	String	To get the vehicle Name.
vehiclemodel	String	To get the vehicle Model.
Time	HH:mm	To get the Time.

53.GPS Per Day

This api is used to get the url for sharing the vehicle details to others.

URL：

http://domainname/getConsolidatedOrgShiftReportForUser

Input Parameters: orgId, fromTimeUtc, toTimeUtc

Parameters

Name	Type	Required	Default Value	Desc
orgId	String	yes	-	To get the organisation Id.
fromTimeUtc	Float	yes	-	To get the from time..
toTimeutc	Float	yes	-	To get the end time.

HTTP Method： GET

Url Example:

http://domainname/getConsolidatedOrgShiftReportForUser?orgId=MSS&fromTimeUtc=1678645800000&toTimeUtc=1678732140000

Response:

Field	Type	Description
vehicleId	String	To get the vehicleId.
shiftName	String	To get the shift Name.
startTime	HH:mm	To get the start Time.
endTime	HH:mm	To get the end Time.

54. Get Live Locations

Goal: Get the newest GPS data of all vehicles of a specified account.

URL： http://<domainname>/apiMobile/getVehicleLocations OR getVehicleDetails4TVS

NOTE: getVehicleLocations will return JSON data while getVehicleDetails4TVS will give XML data only with the same process as on vehicle location.

HTTP Method: GET

Input Parameters: userId, userLocation, group, apiKey, macid, appid , imei, apiKey, language

Common Parameters

Name	Type	Required	Default value	Desc
userId	String	Yes	-	Group Id of the user for which vehicles are allotted.

URL Example：

http://<domainname>/apiMobile/getVehicleLocations?apiKey=ndwlraqfxujojrmktvzg&userId=DEMO&groupId=DEMO:Fcode

Response:

Field	Type	Description
Distance	String	Total Distance covered for all vehicles
rowId	String	Row Count
Group	String	Group Name for which vehicles are grouped under
zoomLevel	String	Map zoom level
Latitude	String	GPS Latitude
Longtitude	String	GPS Longitude
topSpeedVehicleId	String	Top speed vehicle Id
totalMovingVehicles	String	Total moving vehicles count
totalIdleVehicles	String	Total Idle vehicles count
totalParkedVehicles	String	Total parked vehicles count
totalNoDataVehicles	String	Total no data vehicles count
allow Booking	String	For future use
allowed Vehicles	String	For future use
support Details	String	Support details
row ID	Integer	Record count
Latitude	String	GPS latitude
Longitude	String	GPS Longitude
Speed	Integer	Current speed of the vehicle
Date	String	Current date and time (UTC
Alert	String	Type of alert
Direction	String	Course of vehicle (North, South, East , West, NE,NW,SE,SW)
Position	String	Moving, Parked, Static (Idle), NoData
distanceCovered	double	Distance travelled today
odoDistance	double	Vehicle odo meter reading
tankSize	Integer	Fuel Tank Size
Status	String	GPS Status (ON or oFF)
Color	String	Internal use
lastSeen	String	GPS Last Communicated time
ignitionStatus	String	ACC Status (ON or OFF)
insideGeoFence	String	Is vehicle inside Geo fence (yes or no)
isOverSpeed	String	Yes or No
Address	String	Address for the current lat and lng
parkedTime	Integer	Parked time (shown when only vehicle is parked)
movingTime	Integer	Moving time (shown when only vehicle is moving)
idleTime	Integer	Idle time (shown when only vehicle is idle)
noDataTime	Integer	No data time (shown when only vehicle is not communicating)
alertDataTime	String	Alert time (shown when last alert received)
loadTruk	String	Load of the truck received via load sensor
loadTrailer	String	Load of the trailer received via load sensor
totalTruck	String	For future use
totalTrailer	String	For future use
vehicleBusy	String	For future use
fuelLitre	String	Current fuel level in litre
oprName	String	For future use
regNo	String	Vehicle Registration Number
vehicleType	String	Type of vehicle (Truck, Bus, Car)
vehicleId	String	Asset ID. This is very importat.
mobileNo	String	Mobile Number configured (typically drivers mobie Number)
customMarker	String	For future use
deviceModel	String	Model of the device like GT06N etc
shortName	String	Vehicle Name
orgId	String	Organization Name
overSpeedLimit	String	Over Speed Limit
driverName	String	Name of the driver
Live	String	For future use

55.Summary

This documentation is about the open API for the platform Vehicle Tracking System. Any qualified third party applications or websites may utilize this API to empower the business.

This API is based on REST standards, and is compatible with all kinds of programming languages. Many of the fields are self-explanatory

Security

For server side programming API key is not mandatory. IP Listing can be done from GPS provider side. For client side programming API Key is mandatory.

Open API Usage scenarios:

   1. The API is used to extend GPS functionalities of the underlying dealers' own systems.

   2. Accounts of dealers' own systems should be mapped to the assets (IMEIs) of our vehicle-tracking platform.

   3. Dealers' application servers issue API requests to get GPS data.

Usage Workflow

Dealer provides account and password on the vehicle-tracking platform to acquire API Key. Dealer then uses the token on their server to access Open API for needed data.

56.API Summary

Common Parameters:

Name	Type	Mandatory	Desc
apiKey	String	Yes	An apiKey, used to indicate whether the invoker is authorized. Reference to 4.1 for acquiring the token.The apiKey should only be used within your server side code, otherwise it will not work.
userId	String	Yes	The userId which is the one you used to acquire api key
Time	number	Yes	UNIX timestamp, in seconds. Generally the time when the request is invoked.

Parameter Encoding

    The encoding of request and response is utf-8, all parameters in url should be URIEncoded

HTTP MIME Type:

JSON

Content-type: text/html; charset=utf-8

57.API Listing

Acquire apiKey:

   Note: For testing phase this is not required.

   Description： Acquire apiKey

   URL： http://<domainname>/api/getApiKey

   HTTP Method： GET

Input Parameters：

Name	Type	Desc
userId	String	Account of user
Time	Long	Current Unix time stamp from EpochConverter
Signature	String	Encrypted signature; Md5 algorithm： md5(userId+Password)
validDays	String	As a number like 4, and it would be valid for 4 days

URL Example：

http://<domainname>/api/getApiKey?userId=DEMO&time=EpochTime &signature=83accefcd58239d8283da1b0bca78abc&validDays=4

    Note: To convert epochTime -> http://www.epochconverter.com/

Response:

Name	Type	Desc
Status	String	The status parameter written for success or failure
Reason	String	If status is zero, here the reason
apiKey	String	For authorization
expires_in	Number	Expiration of apiKey, in seconds

Note：

  1. apiKey should be used within server side code only, otherwise it will not work.

  2.If a return code is NULL, it means the apiKey has been expired and should be reacquired.

58.FMS Report

This API can be used to get FMS details for a vehicle.

URL: http://<domainname>/apiMobile/getFmsDetails

HTTP Method： GET

Input Parameters： userId, vehicleId, documentType, dueDate, notifyInterval, monthInterval, amount, issuingCompany, note

Specific Parameters

Name	Type	Required	Default
userId	String	yes	-
vehicleId	String	yes	-
documentType	String	no	-1
dueDate	String	no	2018-01-01
notifyInterval	Integer	no	-1
monthInterval	Integer	no	-1
amount	Integer	no	1
issuingCompany	String	no	Govt
note	String	no	-

URL example:

http://<domainname>/apiMobile/getFmsDetails?vehicleId=XYZ&userId=DEMO

Response

Field	Type	Description
error	String	Null
vehicleName	String	VehicleName under a group
vehicleId	String	Asset ID
getFmsData	ArrayList	-
getReminderList	ArrayList	-
serviceList	ArrayList	-
ServiceReminderList	ArrayList	-