GET api/v4/canjourney?userID={userID}&token={token}&serviceID={serviceID}&from={from}&to={to}
Maps to GetExtendedVehicleCANJourneyData from the V4 web service
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userID |
The ID returned from a successful login |
unsigned integer |
Required |
token |
The authentication token returned from a successful login |
string |
Required |
serviceID |
The service id of the vehicle being queried |
unsigned integer |
Required |
from |
The start date being queried yyyyMMddHHmmss |
string |
Required |
to |
The end date being queried yyyyMMddHHmmss |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of can journey data
Collection of Can_Journey_SummaryName | Description | Type | Additional information |
---|---|---|---|
StartFuelLevelLitres | decimal number |
None. |
|
EndFuelLevelLitres | decimal number |
None. |
|
StartAdbluePercentage | decimal number |
None. |
|
EndAdbluePercentage | decimal number |
None. |
|
StartAdblueLitres | decimal number |
None. |
|
EndAdblueLitres | decimal number |
None. |
|
EvBatteryPercentageStart | decimal number |
None. |
|
EvBatteryPercentageEnd | decimal number |
None. |
|
EvBatteryRangeStart | decimal number |
None. |
|
EvBatteryRangeEnd | decimal number |
None. |
|
EvTotalDischargedEnergyStart | decimal number |
None. |
|
EvTotalDischargedEnergyEnd | decimal number |
None. |
|
EvJourneyDischargedEnergy | decimal number |
None. |
|
CanDtcCount | integer |
None. |
|
ServiceId |
The service id of the vehicle |
unsigned integer |
None. |
StartTimeStamp |
The start time of the can journey |
date |
None. |
Duration | integer |
None. |
|
StartLatitude |
The start latitude of the can journey |
decimal number |
None. |
StartLongitude |
The start longitude of the can journey |
decimal number |
None. |
StartStreet |
The start street of the can journey |
string |
None. |
StartTown |
The start town of the can journey |
string |
None. |
StartCountry |
The start country of the can journey |
string |
None. |
EndTimeStamp |
The end time of the can journey |
date |
None. |
EndLatitude |
The end latitude of the can journey |
decimal number |
None. |
EndLongitude |
The end longitude of the can journey |
decimal number |
None. |
EndStreet |
The end street of the can journey |
string |
None. |
EndTown |
The end town of the can journey |
string |
None. |
EndCountry |
The end country of the can journey |
string |
None. |
LastDallasSiteCode |
The last dallas site code of the can journey |
string |
None. |
LastDallasId |
The last dallas id of the can journey |
string |
None. |
DriverAuthFSMState |
If the driver was authorised |
boolean |
None. |
Status |
The status of the can journey |
boolean |
None. |
GPSIdleTime |
GPS idle time in seconds |
integer |
None. |
GPSMaxSpeed |
GPS max speed in mph |
decimal number |
None. |
GPSDistance |
The GPS distance in meters |
integer |
None. |
Fuel |
Fuel used during journey in litres |
decimal number |
None. |
StartFuelLevel |
The start fuel level |
decimal number |
None. |
EndFuelLevel |
The end fuel level |
decimal number |
None. |
CO2 |
The amount of CO2 used in the journey |
decimal number |
None. |
FuelType |
The fuel type |
integer |
None. |
IdleFuel |
Fuel used while idling in litres |
decimal number |
None. |
IdleTime |
The time spent idling in seconds |
integer |
None. |
ExtendedIdleTime |
Time spent extended idling in seconds |
integer |
None. |
PTOFuel |
PTO fuel used in litres |
decimal number |
None. |
PTOTime |
The PTO time |
integer |
None. |
MaxSpeed |
The max speed in mph |
decimal number |
None. |
Distance |
The journey distance in meters |
integer |
None. |
Odometer |
The odometer from the CAN network in meters |
integer |
None. |
GPSOdometer |
The GPS odometer in meters |
integer |
None. |
MaxCoolantTemp |
The maximum coolant temperature in degrees |
decimal number |
None. |
MaxRPM |
The maximum RPM seen during the journey |
integer |
None. |
ClutchCount |
The amount of times the clutch pedal was pressed |
integer |
None. |
BrakeCount |
The amount of times the brake pedal was pressed |
integer |
None. |
MaxAccelTime |
The time the vehicle was at it highest acceleration level in second |
integer |
None. |
MaxAccelTimeThreshold |
The threshold for the maximum acceleration level |
integer |
None. |
MaxRPMTime |
The time the engine was at it highest RPM level in second |
integer |
None. |
MaxRPMTimeThreshold |
The threshold for the maximum RPM level |
integer |
None. |
NumOfHarshAccel |
The number of harsh acceleration events |
integer |
None. |
HarshAccelThreshold |
The harsh acceleration threshold |
decimal number |
None. |
NumOfHarshBrake |
The number of harsh brake events |
integer |
None. |
HarshBrakeThreshold |
The harsh brake threshold |
decimal number |
None. |
NumDTC |
The number of DTC codes seen |
integer |
None. |
DriverFleetCode |
The driver fleet code |
integer |
None. |
DriverClass |
The driver class |
integer |
None. |
ParkBrakeCount |
The amount of times the hand brake was turned on |
integer |
None. |
ExcessThrottleTime |
The time the engine was at an excessively high throttle level in seconds |
integer |
None. |
ExcessEngineRpmTime |
The time the engine was at an excessively high RPM level in seconds |
integer |
None. |
AbsActive |
How long abs was active in seconds |
integer |
None. |
UsedAdBlue |
Amount of AD blue used in litres |
decimal number |
None. |
DriverScore |
Driver score for the journey |
integer |
None. |
StopCount |
The amount of times the vehicle stopped in a journey |
integer |
None. |
ExcessSpeedTime |
The time the vehicle was traveling at an excessively high speed in seconds |
integer |
None. |
CruiseTime |
The time the vehicle was on cruise control in seconds |
integer |
None. |
CoastingTime |
The time the vehicle was coasting in seconds |
integer |
None. |
TorqueTime |
The torque time in seconds |
integer |
None. |
Response Formats
application/json, text/json
[ { "StartFuelLevelLitres": 1.1, "EndFuelLevelLitres": 2.1, "StartAdbluePercentage": 3.1, "EndAdbluePercentage": 4.1, "StartAdblueLitres": 5.1, "EndAdblueLitres": 6.1, "EvBatteryPercentageStart": 7.1, "EvBatteryPercentageEnd": 8.1, "EvBatteryRangeStart": 9.1, "EvBatteryRangeEnd": 10.1, "EvTotalDischargedEnergyStart": 11.1, "EvTotalDischargedEnergyEnd": 12.1, "EvJourneyDischargedEnergy": 13.1, "CanDtcCount": 14, "ServiceId": 15, "StartTimeStamp": "2025-04-27T16:00:47.2874932+00:00", "Duration": 0, "StartLatitude": 17.1, "StartLongitude": 18.1, "StartStreet": "sample string 19", "StartTown": "sample string 20", "StartCountry": "sample string 21", "EndTimeStamp": "2025-04-27T16:00:47.2874932+00:00", "EndLatitude": 23.1, "EndLongitude": 24.1, "EndStreet": "sample string 25", "EndTown": "sample string 26", "EndCountry": "sample string 27", "LastDallasSiteCode": "sample string 28", "LastDallasId": "sample string 29", "DriverAuthFSMState": true, "Status": true, "GPSIdleTime": 32, "GPSMaxSpeed": 33.1, "GPSDistance": 34, "Fuel": 35.1, "StartFuelLevel": 36.1, "EndFuelLevel": 37.1, "CO2": 38.1, "FuelType": 39, "IdleFuel": 40.1, "IdleTime": 41, "ExtendedIdleTime": 42, "PTOFuel": 43.1, "PTOTime": 44, "MaxSpeed": 45.1, "Distance": 46, "Odometer": 47, "GPSOdometer": 48, "MaxCoolantTemp": 49.1, "MaxRPM": 50, "ClutchCount": 51, "BrakeCount": 52, "MaxAccelTime": 53, "MaxAccelTimeThreshold": 54, "MaxRPMTime": 55, "MaxRPMTimeThreshold": 56, "NumOfHarshAccel": 57, "HarshAccelThreshold": 58.1, "NumOfHarshBrake": 59, "HarshBrakeThreshold": 60.1, "NumDTC": 61, "DriverFleetCode": 62, "DriverClass": 63, "ParkBrakeCount": 64, "ExcessThrottleTime": 65, "ExcessEngineRpmTime": 66, "AbsActive": 67, "UsedAdBlue": 68.1, "DriverScore": 69, "StopCount": 70, "ExcessSpeedTime": 71, "CruiseTime": 72, "CoastingTime": 73, "TorqueTime": 74 }, { "StartFuelLevelLitres": 1.1, "EndFuelLevelLitres": 2.1, "StartAdbluePercentage": 3.1, "EndAdbluePercentage": 4.1, "StartAdblueLitres": 5.1, "EndAdblueLitres": 6.1, "EvBatteryPercentageStart": 7.1, "EvBatteryPercentageEnd": 8.1, "EvBatteryRangeStart": 9.1, "EvBatteryRangeEnd": 10.1, "EvTotalDischargedEnergyStart": 11.1, "EvTotalDischargedEnergyEnd": 12.1, "EvJourneyDischargedEnergy": 13.1, "CanDtcCount": 14, "ServiceId": 15, "StartTimeStamp": "2025-04-27T16:00:47.2874932+00:00", "Duration": 0, "StartLatitude": 17.1, "StartLongitude": 18.1, "StartStreet": "sample string 19", "StartTown": "sample string 20", "StartCountry": "sample string 21", "EndTimeStamp": "2025-04-27T16:00:47.2874932+00:00", "EndLatitude": 23.1, "EndLongitude": 24.1, "EndStreet": "sample string 25", "EndTown": "sample string 26", "EndCountry": "sample string 27", "LastDallasSiteCode": "sample string 28", "LastDallasId": "sample string 29", "DriverAuthFSMState": true, "Status": true, "GPSIdleTime": 32, "GPSMaxSpeed": 33.1, "GPSDistance": 34, "Fuel": 35.1, "StartFuelLevel": 36.1, "EndFuelLevel": 37.1, "CO2": 38.1, "FuelType": 39, "IdleFuel": 40.1, "IdleTime": 41, "ExtendedIdleTime": 42, "PTOFuel": 43.1, "PTOTime": 44, "MaxSpeed": 45.1, "Distance": 46, "Odometer": 47, "GPSOdometer": 48, "MaxCoolantTemp": 49.1, "MaxRPM": 50, "ClutchCount": 51, "BrakeCount": 52, "MaxAccelTime": 53, "MaxAccelTimeThreshold": 54, "MaxRPMTime": 55, "MaxRPMTimeThreshold": 56, "NumOfHarshAccel": 57, "HarshAccelThreshold": 58.1, "NumOfHarshBrake": 59, "HarshBrakeThreshold": 60.1, "NumDTC": 61, "DriverFleetCode": 62, "DriverClass": 63, "ParkBrakeCount": 64, "ExcessThrottleTime": 65, "ExcessEngineRpmTime": 66, "AbsActive": 67, "UsedAdBlue": 68.1, "DriverScore": 69, "StopCount": 70, "ExcessSpeedTime": 71, "CruiseTime": 72, "CoastingTime": 73, "TorqueTime": 74 } ]
application/xml, text/xml
<ArrayOfCan_Journey_Summary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Can_Journey_Summary> <StartFuelLevelLitres>1.1</StartFuelLevelLitres> <EndFuelLevelLitres>2.1</EndFuelLevelLitres> <StartAdbluePercentage>3.1</StartAdbluePercentage> <EndAdbluePercentage>4.1</EndAdbluePercentage> <StartAdblueLitres>5.1</StartAdblueLitres> <EndAdblueLitres>6.1</EndAdblueLitres> <EvBatteryPercentageStart>7.1</EvBatteryPercentageStart> <EvBatteryPercentageEnd>8.1</EvBatteryPercentageEnd> <EvBatteryRangeStart>9.1</EvBatteryRangeStart> <EvBatteryRangeEnd>10.1</EvBatteryRangeEnd> <EvTotalDischargedEnergyStart>11.1</EvTotalDischargedEnergyStart> <EvTotalDischargedEnergyEnd>12.1</EvTotalDischargedEnergyEnd> <EvJourneyDischargedEnergy>13.1</EvJourneyDischargedEnergy> <CanDtcCount>14</CanDtcCount> <ServiceId>15</ServiceId> <StartTimeStamp>2025-04-27T16:00:47.2874932+00:00</StartTimeStamp> <StartLatitude>17.1</StartLatitude> <StartLongitude>18.1</StartLongitude> <StartStreet>sample string 19</StartStreet> <StartTown>sample string 20</StartTown> <StartCountry>sample string 21</StartCountry> <EndTimeStamp>2025-04-27T16:00:47.2874932+00:00</EndTimeStamp> <EndLatitude>23.1</EndLatitude> <EndLongitude>24.1</EndLongitude> <EndStreet>sample string 25</EndStreet> <EndTown>sample string 26</EndTown> <EndCountry>sample string 27</EndCountry> <LastDallasSiteCode>sample string 28</LastDallasSiteCode> <LastDallasId>sample string 29</LastDallasId> <DriverAuthFSMState>true</DriverAuthFSMState> <Status>true</Status> <GPSIdleTime>32</GPSIdleTime> <GPSMaxSpeed>33.1</GPSMaxSpeed> <GPSDistance>34</GPSDistance> <Fuel>35.1</Fuel> <StartFuelLevel>36.1</StartFuelLevel> <EndFuelLevel>37.1</EndFuelLevel> <CO2>38.1</CO2> <FuelType>39</FuelType> <IdleFuel>40.1</IdleFuel> <IdleTime>41</IdleTime> <ExtendedIdleTime>42</ExtendedIdleTime> <PTOFuel>43.1</PTOFuel> <PTOTime>44</PTOTime> <MaxSpeed>45.1</MaxSpeed> <Distance>46</Distance> <Odometer>47</Odometer> <GPSOdometer>48</GPSOdometer> <MaxCoolantTemp>49.1</MaxCoolantTemp> <MaxRPM>50</MaxRPM> <ClutchCount>51</ClutchCount> <BrakeCount>52</BrakeCount> <MaxAccelTime>53</MaxAccelTime> <MaxAccelTimeThreshold>54</MaxAccelTimeThreshold> <MaxRPMTime>55</MaxRPMTime> <MaxRPMTimeThreshold>56</MaxRPMTimeThreshold> <NumOfHarshAccel>57</NumOfHarshAccel> <HarshAccelThreshold>58.1</HarshAccelThreshold> <NumOfHarshBrake>59</NumOfHarshBrake> <HarshBrakeThreshold>60.1</HarshBrakeThreshold> <NumDTC>61</NumDTC> <DriverFleetCode>62</DriverFleetCode> <DriverClass>63</DriverClass> <ParkBrakeCount>64</ParkBrakeCount> <ExcessThrottleTime>65</ExcessThrottleTime> <ExcessEngineRpmTime>66</ExcessEngineRpmTime> <AbsActive>67</AbsActive> <UsedAdBlue>68.1</UsedAdBlue> <DriverScore>69</DriverScore> <StopCount>70</StopCount> <ExcessSpeedTime>71</ExcessSpeedTime> <CruiseTime>72</CruiseTime> <CoastingTime>73</CoastingTime> <TorqueTime>74</TorqueTime> </Can_Journey_Summary> <Can_Journey_Summary> <StartFuelLevelLitres>1.1</StartFuelLevelLitres> <EndFuelLevelLitres>2.1</EndFuelLevelLitres> <StartAdbluePercentage>3.1</StartAdbluePercentage> <EndAdbluePercentage>4.1</EndAdbluePercentage> <StartAdblueLitres>5.1</StartAdblueLitres> <EndAdblueLitres>6.1</EndAdblueLitres> <EvBatteryPercentageStart>7.1</EvBatteryPercentageStart> <EvBatteryPercentageEnd>8.1</EvBatteryPercentageEnd> <EvBatteryRangeStart>9.1</EvBatteryRangeStart> <EvBatteryRangeEnd>10.1</EvBatteryRangeEnd> <EvTotalDischargedEnergyStart>11.1</EvTotalDischargedEnergyStart> <EvTotalDischargedEnergyEnd>12.1</EvTotalDischargedEnergyEnd> <EvJourneyDischargedEnergy>13.1</EvJourneyDischargedEnergy> <CanDtcCount>14</CanDtcCount> <ServiceId>15</ServiceId> <StartTimeStamp>2025-04-27T16:00:47.2874932+00:00</StartTimeStamp> <StartLatitude>17.1</StartLatitude> <StartLongitude>18.1</StartLongitude> <StartStreet>sample string 19</StartStreet> <StartTown>sample string 20</StartTown> <StartCountry>sample string 21</StartCountry> <EndTimeStamp>2025-04-27T16:00:47.2874932+00:00</EndTimeStamp> <EndLatitude>23.1</EndLatitude> <EndLongitude>24.1</EndLongitude> <EndStreet>sample string 25</EndStreet> <EndTown>sample string 26</EndTown> <EndCountry>sample string 27</EndCountry> <LastDallasSiteCode>sample string 28</LastDallasSiteCode> <LastDallasId>sample string 29</LastDallasId> <DriverAuthFSMState>true</DriverAuthFSMState> <Status>true</Status> <GPSIdleTime>32</GPSIdleTime> <GPSMaxSpeed>33.1</GPSMaxSpeed> <GPSDistance>34</GPSDistance> <Fuel>35.1</Fuel> <StartFuelLevel>36.1</StartFuelLevel> <EndFuelLevel>37.1</EndFuelLevel> <CO2>38.1</CO2> <FuelType>39</FuelType> <IdleFuel>40.1</IdleFuel> <IdleTime>41</IdleTime> <ExtendedIdleTime>42</ExtendedIdleTime> <PTOFuel>43.1</PTOFuel> <PTOTime>44</PTOTime> <MaxSpeed>45.1</MaxSpeed> <Distance>46</Distance> <Odometer>47</Odometer> <GPSOdometer>48</GPSOdometer> <MaxCoolantTemp>49.1</MaxCoolantTemp> <MaxRPM>50</MaxRPM> <ClutchCount>51</ClutchCount> <BrakeCount>52</BrakeCount> <MaxAccelTime>53</MaxAccelTime> <MaxAccelTimeThreshold>54</MaxAccelTimeThreshold> <MaxRPMTime>55</MaxRPMTime> <MaxRPMTimeThreshold>56</MaxRPMTimeThreshold> <NumOfHarshAccel>57</NumOfHarshAccel> <HarshAccelThreshold>58.1</HarshAccelThreshold> <NumOfHarshBrake>59</NumOfHarshBrake> <HarshBrakeThreshold>60.1</HarshBrakeThreshold> <NumDTC>61</NumDTC> <DriverFleetCode>62</DriverFleetCode> <DriverClass>63</DriverClass> <ParkBrakeCount>64</ParkBrakeCount> <ExcessThrottleTime>65</ExcessThrottleTime> <ExcessEngineRpmTime>66</ExcessEngineRpmTime> <AbsActive>67</AbsActive> <UsedAdBlue>68.1</UsedAdBlue> <DriverScore>69</DriverScore> <StopCount>70</StopCount> <ExcessSpeedTime>71</ExcessSpeedTime> <CruiseTime>72</CruiseTime> <CoastingTime>73</CoastingTime> <TorqueTime>74</TorqueTime> </Can_Journey_Summary> </ArrayOfCan_Journey_Summary>