General Telemetry

Detailed description of API:

Version & Updates

View Previous Revisions

Version	Revision Date	Revision History
1.0	December 2022	New Release
1.1	Jan 2023	Added Unified API to the list
1.2	Jan 2023	Added Unified API 24 Hours to the list
1.3	Jan 2023	Updated unified24telemetry to V1
1.5	Feb 2023	Updated Unified 24 hrs. telemetry API JSON
1.6	31st Aug 2023	Updated the Prod URLs, Pictorial representation of the data flow, Pre-requisites to access the API, Response Codes. Moved Authentication Section to API and Connection Details, Sample Request and Response files to Sample Request and Responses section. Renamed Connection Details to API and Connection Details. Corrected Navigation Headings
1.7	8th Sep 2023	Updated description in both ‘Overview’ and ‘Unified 24 Hrs. API’ sections, API Request parameter types in ‘API Request Description’ section. Added API, Request types.
1.8	16th Oct 2023	Project title change
1.9	13th May 2024	Distance API removal, sunset of API
2.0	10th Jun 2025	Corrected Fuel Remaining Ratio API’s URL & Added EMEA URLs for 24 hours and 7 days APIs

Version	Revision Date	Revision History
2.1	25th Jun 2025	Added request types

Overview

Telemetry API intends to provide the parameter information of the different parts of an equipment, which are collected from the modem in real time like AM53, PCM etc., which enables the users to understand the part parameters before or while creating the work order in DMS. The API set can be querried for telemetry data by the following methods:

1. For a given equipment in one day.
2. For a given equipment at a specific date and time
3. For a given equipment in an aggregated format (hourly/day) between dates

The API provides information about geographical and the parametric values for all the critical parts of the equipment between the requested dates (as applicable) as a response. All the telemetry and its relevant data are extracted from the Geo Spatial System (GSS) of CNHi. Pictorial representation of the data flows below.

Pre-requisites

Pre-requisites

• Dealer must use their Dealer Portal credentials to authorize API call
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• Each Subscription key is unique to DMS and the environment it belongs to
• User within Ownership Group has accepted CNH's Data Acknowledgement (if located in NAFTA)

Authentication

Authentication

• DMS will pass Basic auth in HTTP header with username/password
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
• DEP API will require subscription_key in HTTP header to identify client

API Format

• REST

The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. New DMSs who are building this interface are recommended to the use the REST API for greater simplicity.

Connection Details

There are a total of 18 APIs for this interface, the two Unified APIs are an aggregate of the frequently used metrics for greater simplicity of having a single API call.

CNHi provides both a UAT/Staging and a Production interface for General Telemetry. VINs may be unavailable within staging environment, please reach out to CNHi for VIN examples (if necessary).

Unified API (7 Days)

Unified 7 day API returns an aggregate response of a predetermined (up to) a 7 day date range of the following APIs:

• CumulativeOperatingHours
• Location
• MaxTransmissionOilTemp
• MaxHydraulicOilTemp
• MaxIntakeManifoldTemp
• EngineStatus
• FuelRemaining
• MaxEngineCoolantTemp
• MaxEngineOilTemp
• DEFRemaining
• Speed

NAFTA Endpoints

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/UnifiedTelemetry/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/UnifiedTelemetry/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
TelemetryUnifiedMessages.Links.Rel	String	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
TelemetryUnifiedMessages.Links.Href	String	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
TelemetryUnifiedMessages.Metrics.DateTime	String	Date and Time Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
TelemetryUnifiedMessages.Metrics.CumulativeOperatingHours.Hour	String	The current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hour meter on the machine.
TelemetryUnifiedMessages.Metrics.Locations.Latitude	String	Latitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.Longitude	String	Longitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.Altitude	String	The altitude is expressed as distance above mean sea level of the machine’s location. Altitude is reported in meters. This field is optional.
TelemetryUnifiedMessages.Metrics.Locations.AltitudeUnits	String	The altitude of the location shall be expressed in meters. If altitude is included in the response, this field is mandatory. It shall have the value “meter”.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.Temperature	Decimal	The parameter indicates the maximum transmission oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.UnitOfMeasure	String	Unit of measure of transmission oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.Temperature	Decimal	The parameter indicates the maximum hydraulic oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.UnitOfMeasure	String	Unit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.Temperature	Decimal	The parameter indicates the maximum Intake Manifold temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.UnitOfMeasure	String	Unit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.EngineStatus .Running	String	The parameter indicates Engine running status at particular date and time.
TelemetryUnifiedMessages.Metrics.FuelRemaining.Fuel	String	The parameter indicates fuel remaining percentage.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.Temperature	Decimal	The parameter indicates the maximum Engine Coolant temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.UnitOfMeasure	String	Unit of measure of engine coolant Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.Temperature	Decimal	The parameter indicates the maximum Engine Oil temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.UnitOfMeasure	String	Unit of measure of engine oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.DEFRemaining.Percent	Decimal	Percentage of DEF Remaining at particular Date and Time.
TelemetryUnifiedMessages.Metrics.Speed.SpeedUnits	String	Unit of measure of Speed of the vehicle (KM/H)
TelemetryUnifiedMessages.Metrics.Speed.Speed	Decimal	The parameter indicates speed of the vehicle at Date and Time.

Sample Response

Download Unified API (7 Days) API Response

Unified API (Last 24 Hours)

Unified 24 Hour API returns an aggregate response of the last 24 hours of the the following APIs:

• CumulativeOperatingHours
• Location
• MaxTransmissionOilTemp
• MaxHydraulicOilTemp
• MaxIntakeManifoldTemp
• EngineStatus
• FuelRemaining
• MaxEngineCoolantTemp
• MaxEngineOilTemp
• DEFRemaining
• Speed

NAFTA Endpoints

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/latest/{assetID}/unified24telemetry	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/latest/{assetID}/unified24telemetry	REST	GET

Request Parameters

Name	Input	Type	Is Required	Comments
assetID	Template Parameter	String	True	VIN

Response Description

Name	Type	Description
TelemetryUnifiedMessages.Links.Rel	String	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
TelemetryUnifiedMessages.Links.Href	String	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
TelemetryUnifiedMessages.Metrics.DateTime	String	Date and Time Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
TelemetryUnifiedMessages.Metrics.CumulativeOperatingHours.Hour	String	The current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hour meter on the machine.
TelemetryUnifiedMessages.Metrics.Locations.Latitude	String	Latitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.Longitude	String	Longitude, GPS data. From pos_point Point object.
TelemetryUnifiedMessages.Metrics.Locations.Altitude	String	The altitude is expressed as distance above mean sea level of the machine’s location. Altitude is reported in meters. This field is optional.
TelemetryUnifiedMessages.Metrics.Locations.AltitudeUnits	String	The altitude of the location shall be expressed in meters. If altitude is included in the response, this field is mandatory. It shall have the value “meter”.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.Temperature	Decimal	The parameter indicates the maximum transmission oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxTransmissionOilTemp.UnitOfMeasure	String	Unit of measure of transmission oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.Temperature	Decimal	The parameter indicates the maximum hydraulic oil temperature at date and time.
TelemetryUnifiedMessages.Metrics.MaxHydraulicOilTemp.UnitOfMeasure	String	Unit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.Temperature	Decimal	The parameter indicates the maximum Intake Manifold temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxIntakeManifoldTemp.UnitOfMeasure	String	Unit of measure of hydraulic oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.EngineStatus.Running	String	The parameter indicates Engine running status at particular date and time.
TelemetryUnifiedMessages.Metrics.FuelRemaining.Fuel	String	The parameter indicates fuel remaining percentage.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.Temperature	Decimal	The parameter indicates the maximum Engine Coolant temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.MaxEngineCoolantTemp.UnitOfMeasure	String	Unit of measure of engine coolant Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.Temperature	Decimal	The parameter indicates the maximum Engine Oil temperature at particular date and time.
TelemetryUnifiedMessages.Metrics.maxEngineOilTemp.UnitOfMeasure	String	Unit of measure of engine oil Temperature (Celsius).
TelemetryUnifiedMessages.Metrics.DEFRemaining.Percent	Decimal	Percentage of DEF Remaining at particular Date and Time.
TelemetryUnifiedMessages.Metrics.Speed.SpeedUnits	String	Unit of measure of Speed of the vehicle (KM/H)
TelemetryUnifiedMessages.Metrics.Speed.Speed	Decimal	The parameter indicates speed of the vehicle at Date and Time.

Sample Response

Download Unified API (Last 24 Hours) API Response

Caution Code API

Caution Code returns both the caution code present on the vehicle and code description

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/CautionCodes/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/CautionCodes/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
cautionMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
cautionMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
CautionMessages.CautionDescription.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ss
CautionMessages.CautionDescription.Identifier	String	Caution code identifier
CautionMessages.CautionDescription.Description	String	Caution code description

Sample Response

Download Caution Code API Response

Cumulative Fuel Used API

Cumulative fuel used API returns the total fuel consumption at the requested datetime.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeFuelUsed/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeFuelUsed/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
FuelUsedMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
FuelUsedMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
FuelUsedMessages.FuelUsed.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ss
FuelUsedMessages,FuelUsed.FuelUnits	String	The quantity of fuel is expressed in litres. If cumulative fuel used is included in the response, this field will be in metric unit of litres.
FuelUsedMessages.FuelUsed.FuelConsumed	Double	The value is expressed as an unsigned integer, which includes all values from 0 through 4,294,967,295.

Sample Response

Download Cumulative Fuel Used API Response

Cumulative Idle Hours API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeIdleHours/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeIdleHours/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
CumulativeIdlehoursMessages.Links.Rel	String	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
CumulativeIdlehoursMessages.Links.Href	String	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
CumulativeIdlehoursMessages.ComulativeIdlehours.DateTime	String	Date and Time are expressed as: YYYY-MM-DDThh:mm:ss
CumulativeIdlehoursMessages.ComulativeIdlehours.Hours	String	The current total lifetime Idle hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hour meter on the machine.

Sample Response

Download Cumulative Idle Hours API Response

Cumulative Nonproductive Idle Hours API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeNonProductiveIdleHours/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeNonProductiveIdleHours/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
CumulativeNonProductiveIdleHoursMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
CumulativeNonProductiveIdleHoursMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
CumulativeNonProductiveIdleHoursMessages.CumulativeNonProductiveIdleHours.DateTime	string	Date and TimeD Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
CumulativeNonProductiveIdleHoursMessages.CumulativeNonProductiveIdleHours.Hour	decimal	The parameter indicates the CumulativeNonProductiveIdleHours at particular date and time.

Sample Response

Download Cumulative Nonproductive Idle Hours API Response

Cumulative Operating Hours API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeOperatingHours/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/CumulativeOperatingHours/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
CumulativeOperatingHoursMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
CumulativeOperatingHoursMessages.Links.Href	String	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
CumulativeOperatingHoursMessages.CumulativeOperatingHours.DateTime	String	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
CumulativeOperatingHoursMessages.CumulativeOperatingHours. Hour	String	The current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hour meter on the machine.

Sample Response

Download Cumulative Operating Hours API Response

DEF Remaining API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/DEFRemaining/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/DEFRemaining/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
DEFRemainingMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
DEFRemainingMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
DEFRemainingMessages.DEFRemaining.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
DEFRemainingMessages.DEFRemaining.Percent	decimal	Percentage of DEF Remaining at particular Date and Time.

Sample Response

Download DEF Remaining API Response

Engine Condition API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/EngineCondition/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/EngineCondition/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
EngineStatusMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
EngineStatusMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
EngineStatusMessages.EngineStatus.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
EngineStatusMessages.EngineStatus.EngineNumber	string	The parameter indicates Engine Number.
EngineStatusMessages.EngineStatus.Running	string	The parameter indicates Engine running status at particular date and time.

Sample Response

Download Engine Condition API Response

Fuel Remaining Ratio API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/FuelRemainingRatio/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/FuelRemainingRatio/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
FuelRemainingMessage.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
FuelRemainingMessage.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
FuelRemainingMessage.FuelRemaining.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
FuelRemainingMessage.FuelRemaining.Fuel	string	The parameter indicates fuel remaining percentage.

Sample Response

Download Fuel Remaining API Response

Fuel Used in Preceding 24 Hours API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/fuelusedinthepreceding24hours/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/fuelusedinthepreceding24hours/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
fuelUsedLast24Messages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
fuelUsedLast24Messages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
FuelUsedLast24Messages.fuelUsedLast24.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
FuelUsedLast24Messages.fuelUsedLast24.FuelUnits	string	Unit of measure of Fuel Consumed (Liters).
fuelUsedLast24Messages.fuelUsedLast24.FuelConsumed	decimal	The parameter indicates the amount of Fuel Consumed In the preceding 24 hours.

Sample Response

Download Fuel Used in Preceding 24 Hours API Response

Location API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/Locations/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/Locations/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
LocationMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
LocationMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
LocationMessages.Locations.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
LocationMessages.Locations.Latitude	String	Latitude, GPS data. From pos_point Point object.
LocationMessages.Locations.Longitude	String	Longitude, GPS data. From pos_point Point object.
LocationMessages.Locations.Altitude	String	The altitude is expressed as distance above mean sea level of the machine’s location. Altitude is reported in meters. This field is optional.
LocationMessages.Locations.AltitudeUnits	String	The altitude of the location shall be expressed in meters. If altitude is included in the response, this field is mandatory.

Sample Response

Download Location API Response

Max Engine Coolant Temperature API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxEngineCoolantTemp/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxEngineCoolantTemp/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
maxEngineCoolantTempMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
maxEngineCoolantTempMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
maxEngineCoolantTempMessages.maxEngineCoolantTemp.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
maxEngineCoolantTempMessages.MaxEngineCoolantTemp.Temperature	decimal	The parameter indicates the maximum Engine Coolant temperature at particular date and time.
maxEngineCoolantTempMessages.MaxEngineCoolantTemp.UnitOfMeasure	string	Unit of measure of engine coolant Temperature (Celsius).

Sample Response

Download Max Engine Coolant Temperature API Response

Max Engine Oil Temperature API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxEngineOilTemp/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxEngineOilTemp/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
maxEngineOilTempMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
maxEngineOilTempMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
maxEngineOilTempMessages.maxEngineOilTemp.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
maxEngineOilTempMessages.maxEngineOilTemp.Temperature	decimal	The parameter indicates the maximum Engine Oil temperature at particular date and time.
maxEngineOilTempMessages.maxEngineOilTemp.UnitOfMeasure	string	Unit of measure of engine oil Temperature (Celsius).

Sample Response

Download Max Engine Oil Temperature API Response

Max Hydraulic Oil Temperature API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxHydraulicOilTemp/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxHydraulicOilTemp/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
MaxHydraulicOilTempMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
MaxHydraulicOilTempMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
MaxHydraulicOilTempMessages.MaxHydraulicOilTemp.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
MaxHydraulicOilTempMessages.MaxHydraulicOilTemp.Temperature	decimal	The parameter indicates the maximum hydraulic oil temperature at date and time.
MaxHydraulicOilTempMessages.MaxHydraulicOilTemp.UnitOfMeasure	string	Unit of measure of hydraulic oil Temperature (Celsius).

Sample Response

Download Max Hydraulic Oil Temperature API Response

Max Intake Manifold Temperature API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxIntakeManifoldTemp/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxIntakeManifoldTemp/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
MaxIntakeManifoldTempMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
MaxIntakeManifoldTempMessages.Links.Href	String	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
MaxIntakeManifoldTempMessages.MaxIntakeManifoldTemp.DateTime	String	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
MaxIntakeManifoldTempMessages.MaxIntakeManifoldTemp.Temperature	Decimal	The parameter indicates the maximum Intake Manifold temperature at particular date and time.
MaxIntakeManifoldTempMessages.MaxIntakeManifoldTemp.UnitOfMeasure	String	Unit of measure of hydraulic oil Temperature (Celsius).

Sample Response

Download Max Intake Manifold Temperature API Response

Max Transmission Oil Temperature API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxTransmissionOilTemp/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/MaxTransmissionOilTemp/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
MaxTransmissionOilTempMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
MaxTransmissionOilTempMessages.Links.Href	String	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
MaxTransmissionOilTempMessages.MaxTransmissionOilTemp.DateTime	String	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
MaxTransmissionOilTempMessages.MaxTransmissionOilTemp.Temperature	decimal	The parameter indicates the maximum transmission oil temperature at date and time.
MaxTransmissionOilTempMessages.MaxTransmissionOilTemp.UnitOfMeasure	String	Unit of measure of transmission oil Temperature (Celsius).

Sample Response

Download Max Transmission OIl Temperature API Response

Peak Daily Speed API

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/v1/fleet/equipment/{assetID}/PeakDailySpeed/{startDate}/{endDate}	REST	GET
Production	https://{base_url}/external/v1/fleet/equipment/{assetID}/PeakDailySpeed/{startDate}/{endDate}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
assetID	Template Parameter	String	True	-	VIN Number
startDate	Template Parameter	Date Time	True	-	Start Date
endDate	Template Parameter	Date Time	True	-	End Date

Response Description

Name	Type	Description
peakDailySpeedMessages.Links.Rel	string	Relationship – The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).
peakDailySpeedMessages.Links.Href	string	Hyperlink – the hypermedia reference URL (href) is a reference to another endpoint.
PeakDailySpeedMessages.Speed.DateTime	string	Date and Time are expressed as: YYYY-MM-DDThh:mm:ssZ
peakDailySpeedMessages.Speed.SpeedUnits	String	Unit of measure of Speed of the vehicle (KM/H)
peakDailySpeedMessages.Speed.Speed	Decimal	The parameter indicates speed of the vehicle at particular Date and Time.

Sample Response

Download Peak Daily Speed API Response

Response Codes

Status Code	Message	Reason
200	API request success	Succesful connection to API and backend
500	Internal Server Error	Unsuccessful conection to API or backend
401	Access denied due to invalid credentials!	Bad credentials, check username and password
404	The requested VIN is not a connected vehicle, please check the VIN.	Vehicle does not have modem or telematic equipment.
404	VIN is not available, please check the VIN.	Incorrect VIN input.
404	No data found, Telematic subscription has expired for this VIN.	Telematic subscription for the VIN has expired.
404	Vehicle data currently not available due to Telematic connectivity issue.	Vehicle is unable to connect/transmit telematic data.
404	The requested VIN is inactive or has never been activated, please check Telematic subscription.	Telematic subscription is either inactive or not activated.
404	The requested VIN or Telematic data could not be found but may be available in the future, please check the VIN and Telematic subscription.	Service is down and/or trouble with backend.