Export ISO 15143-3 (AEMP 2.0)
Our ISO Export API follows the ISO15143-3 standard. It provides fleet-wide equipment information.
To ease system integration, additional equipment metadata is available as an optional addition to the ISO standard. See "Additional Metadata"-section for further details.
Subscription requirement
The Export API is only available to customers on the Collect or Insight subscription package!
Interface
The API expose a simple XML REST interface that you can call directly using your OAuth 2.0 access token. See Access IRIS APIs for further details on how to obtain an access token.
Response format
The AEMP ISO 15143-3 API serving XML or JSON as output formats. You can choose it by sending Accept header with either application/xml or application/json. XML is a default format.
Rate Limiting
Requests are rate limited to one request per page every 15 min. To ease development 50 unrestricted requests are available upon initial use.
There are also limits on allowed requests per second per customer (ie. includes all API accounts for the same customer):
- 50 requests / 1s to fleet snapshot pages,
- 500 requests / 1s to single-element snapshot endpoint,
- 500 requests / 1s to all timeseries endpoints counted together.
Pagination
The AEMP ISO 15143-3 API implements pagination as described in the ISO15143-3 standard. Response collections are limited to 100 per page. The page number of the first page is always one. Each response contains "Links", which provides navigation to self, prev, next and last page.
<Links>
<rel>self</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/2</href>
</Links>
<Links>
<rel>next</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/3</href>
</Links>
<Links>
<rel>prev</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/1</href>
</Links>
<Links>
<rel>last</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/993</href>
</Links>
Additional Metadata
As an extension to the ISO standard the client can, by adding addMetadata=true as URL param, request additional metadata containing equipment related IDs used to ease system integration.
<Metadata>
<TelematicSerialNumber>927096</TelematicSerialNumber>
<MachineId>035c52d4-a533-4a83-8687-a5a7489a5af4</MachineId>
<UnitId>958947</UnitId>
<ExternalReferenceNumber>ref-927096</ExternalReferenceNumber>
</Metadata>
Additional Machine Insights
An extension to the ISO standard is a collection of elements that represent Machine Insights that do not fit in the standard schema. The client can request it by adding addExtendedData=true URL param. Value is deprecated and may be removed in future releases. Specific values like BatteryPotential should be used.
<BatteryPotential datetime="2021-01-02T12:22:00Z">
<BatteryPotential>13.3</BatteryPotential>
<Value>13.3</Value>
</BatteryPotential>
<CumulativeMovingHours datetime="2021-01-02T12:30:52Z">
<Hour>21.05</Hour>
<Value>21.05</Value>
</CumulativeMovingHours>
<xs:complexType name="ExtendedEquipment">
<xs:sequence>
<xs:element name="EngineFuelRate" type="EngineFuelRateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineSpeed" type="SpeedExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineOilPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineOilTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineCoolantTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineCoolantLevel" type="LevelExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineExhaustTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WaterInFuelIndicator" type="WaterInFuelIndicatorExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="HydraulicTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="HydraulicOilLevel" type="LevelExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryPotential" type="BatteryPotentialExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SeatBeltSwitch" type="SeatBeltSwitchExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EnginePercentLoadAtCurrentSpeed" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ActualEnginePercentTorque" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PitchAngle" type="AngleExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RollAngle" type="AngleExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterSootLoadPercent" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterAshLoadPercent" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration" type="AftertreatmentDieselParticulateFilterTimeSinceLastActiveRegenerationExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterPassiveRegenerationStatus" type="StatusExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterStatus" type="StatusExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterActiveRegenerationStatus " type="StatusExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselExhaustFluidTankTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentScrOperatorInducementSeverity" type="AfterTreatmentScrOperatorInducementSeverityExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselExhaustFluidConcentration" type="AftertreatmentDieselExhaustFluidConcentrationExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DieselParticulateFilterActiveRegenerationInhibitedDueToInhibitSwitch" type="DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitchExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PayloadPercentage" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GeneratorTotalKwHoursExport" type="GeneratorTotalkWHoursExportExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="HydraulicOilFilterRestrictionSwitch" type="HydraulicOilFilterRestrictionSwitchExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ServiceComponentIdentification" type="ServiceComponentIdentificationExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineFuelDeliveryPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineCoolantPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="WheelBasedVehicleSpeed" type="SpeedExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BarometricPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AmbientAirTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineIntakeAirTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RoadSurfaceTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineIntakeManifoldTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineAirFilterDifferentialPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryChargerState" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryChargerPowerLineState" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryChargerOutputVoltage" type="BatteryChargerOutputVoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryChargerOutputCurrent" type="BatteryChargerOutputCurrentExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineTripFuel" type="EngineTripFuelExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterDifferentialPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentDieselParticulateFilterIntakeTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AfterTreatmentExhaustTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AmberWarningLamp" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DieselParticulateFilterLampCommand" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineFuelTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineIntakeAirPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineIntakeManifoldPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineIntercoolerTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineOilLevel" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EngineTotalIdleFuelUsed" type="FuelUsedExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ExhaustSystemHighTemperatureLampCommand" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="HydraulicPressure" type="PressureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MalfunctionIndicatorLamp" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ProtectLamp" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RedStopLamp" type="StateExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TransmissionOilTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CumulativeProductiveHours" type="CumulativeHoursExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CumulativeMovingHours" type="CumulativeHoursExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Speed" type="SpeedExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OperationStatus" type="StatusExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CumulativeEngineHours" type="CumulativeHoursExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PlatformHeightPercent" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PlatformHeight" type="LengthExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PlatformElevated" type="StatusExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Payload" type="PayloadTotalsExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryStateOfChargePercent" type="PercentageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryCurrent" type="CurrentExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BatteryTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL1NeutralRMSVoltage" type="VoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL2NeutralRMSVoltage" type="VoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL3NeutralRMSVoltage" type="VoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL1Frequency" type="FrequencyExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL2Frequency" type="FrequencyExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL3Frequency" type="FrequencyExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL1RMSCurrent" type="CurrentExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL2RMSCurrent" type="CurrentExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL3RMSCurrent" type="CurrentExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL1L2RMSVoltage" type="VoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL2L3RMSVoltage" type="VoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL3L1RMSVoltage" type="VoltageExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcTotalActivePower" type="PowerExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL1ActivePower" type="PowerExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL2ActivePower" type="PowerExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcPhaseL3ActivePower" type="PowerExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcTotalApparentPower" type="PowerExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcTotalPowerFactor" type="FactorExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AcTotalReactivePower" type="PowerExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PayloadTemperature" type="TemperatureExtended" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation></xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="EngineFuelRateExtended">
<xs:sequence>
<xs:element name="EngineFuelRate" minOccurs="0" maxOccurs="1" type="xs:decimal">
</xs:element>
<xs:element name="Value" minOccurs="0" maxOccurs="1" type="xs:decimal">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use EngineFuelRate value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="SpeedExtended">
<xs:sequence>
<xs:element name="SpeedUnits" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Speed" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Speed value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="PressureExtended">
<xs:sequence>
<xs:element name="Pressure" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Pressure value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="TemperatureExtended">
<xs:sequence>
<xs:element name="Temperature" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Temperature value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="LevelExtended">
<xs:sequence>
<xs:element name="Level" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Level value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="WaterInFuelIndicatorExtended">
<xs:sequence>
<xs:element name="WaterInFuelIndicator" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use WaterInFuelIndicator value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="BatteryPotentialExtended">
<xs:sequence>
<xs:element name="BatteryPotential" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use BatteryPotential value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="SeatBeltSwitchExtended">
<xs:sequence>
<xs:element name="SeatBeltSwitch" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use SeatBeltSwitch value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="PercentageExtended">
<xs:sequence>
<xs:element name="Percentage" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Percentage value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="AngleExtended">
<xs:sequence>
<xs:element name="Angle" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Angle value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="AftertreatmentDieselParticulateFilterTimeSinceLastActiveRegenerationExtended">
<xs:sequence>
<xs:element name="AftertreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use AftertreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="StatusExtended">
<xs:sequence>
<xs:element name="Status" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Status value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="AfterTreatmentScrOperatorInducementSeverityExtended">
<xs:sequence>
<xs:element name="AfterTreatmentScrOperatorInducementSeverity" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use AfterTreatmentScrOperatorInducementSeverity value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="AftertreatmentDieselExhaustFluidConcentrationExtended">
<xs:sequence>
<xs:element name="AftertreatmentDieselExhaustFluidConcentration" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use AftertreatmentDieselExhaustFluidConcentration value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitchExtended">
<xs:sequence>
<xs:element name="DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitch" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitch value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="GeneratorTotalkWHoursExportExtended">
<xs:sequence>
<xs:element name="GeneratorTotalkWHoursExport" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use GeneratorTotalkWHoursExport value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="HydraulicOilFilterRestrictionSwitchExtended">
<xs:sequence>
<xs:element name="HydraulicOilFilterRestrictionSwitch" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use HydraulicOilFilterRestrictionSwitch value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="ServiceComponentIdentificationExtended">
<xs:sequence>
<xs:element name="ServiceComponentIdentification" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use ServiceComponentIdentification value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="StateExtended">
<xs:sequence>
<xs:element name="State" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use State value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="BatteryChargerOutputVoltageExtended">
<xs:sequence>
<xs:element name="BatteryChargerOutputVoltage" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use BatteryChargerOutputVoltage value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="BatteryChargerOutputCurrentExtended">
<xs:sequence>
<xs:element name="BatteryChargerOutputCurrent" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use BatteryChargerOutputCurrent value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="EngineTripFuelExtended">
<xs:sequence>
<xs:element name="EngineTripFuel" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use BatteryChargerOutputCurrent value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="FuelUsedExtended">
<xs:sequence>
<xs:element name="FuelUnits" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="FuelConsumed" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use FuelConsumed value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="CumulativeHoursExtended">
<xs:sequence>
<xs:element name="Hour" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Hour value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="LocationMetadataExtended">
<xs:sequence>
<xs:element name="HighAccuracy" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="AccuracyRadius" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use AccuracyRadius value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="LengthExtended">
<xs:sequence>
<xs:element name="Length" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Length value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="PayloadTotalsExtended">
<xs:sequence>
<xs:element name="PayloadUnits" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Payload" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Payload value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="CurrentExtended">
<xs:sequence>
<xs:element name="Current" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Current value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="VoltageExtended">
<xs:sequence>
<xs:element name="Voltage" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Voltage value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="FrequencyExtended">
<xs:sequence>
<xs:element name="Frequency" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Frequency value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="PowerExtended">
<xs:sequence>
<xs:element name="Unit" type="xs:string" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Power" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Power value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
<xs:complexType name="FactorExtended">
<xs:sequence>
<xs:element name="Factor" type="xs:decimal" minOccurs="0" maxOccurs="1">
</xs:element>
<xs:element name="Value" type="xs:decimal" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>This value is deprecated and may be removed in future versions. Please use Factor value instead.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="datetime" type="xs:dateTime" use="required">
</xs:attribute>
</xs:complexType>
Serial Number
If the equipment's serial number is unavailable then the telematic device's serial number will be inserted into the equipment serial number field. This is subject to change in the future as we apply to the standard.
Please obtain telematic device's serial number from additional metadata to avoid being impacted by future changes.
Fleet snapshot
URL: /Fleet/{pageNumber}
The fleet snapshot provides the snapshot of the latest available telematics data.
The response is limited to a maximum of 100 records per page.
Sample response
The sample response below contains two equipment elements - one for the sample machine, another for a Trackunit Kin tag installed on the asset. The response contains an optional Metadata element for each equipment.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fleet xmlns="http://standards.iso.org/iso/15143/-3" version="0">
<Links>
<rel>self</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/1</href>
</Links>
<Links>
<rel>next</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/2</href>
</Links>
<Links>
<rel>last</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/4</href>
</Links>
<Equipment>
<EquipmentHeader>
<OEMName>Kramer</OEMName>
<Model>4095</Model>
<EquipmentID>K4095-1</EquipmentID>
<SerialNumber>453020511</SerialNumber>
<PIN>453020511</PIN>
</EquipmentHeader>
<Location datetime="2021-08-04T11:57:10Z">
<Latitude>39.71107699999882</Latitude>
<Longitude>-104.79963966666429</Longitude>
</Location>
<CumulativeOperatingHours datetime="2021-08-04T11:57:30Z">
<Hour>1444.60</Hour>
</CumulativeOperatingHours>
<Distance datetime="2021-08-04T11:57:10Z">
<OdometerUnits>kilometre</OdometerUnits>
<Odometer>1806.00</Odometer>
</Distance>
<EngineStatus datetime="2021-08-04T11:57:10Z">
<EngineNumber>N/A</EngineNumber>
<Running>false</Running>
</EngineStatus>
<FuelUsed datetime="2021-08-04T11:57:30Z">
<FuelUnits>litre</FuelUnits>
<FuelConsumed>4091</FuelConsumed>
</FuelUsed>
<Metadata>
<TelematicSerialNumber>927096</TelematicSerialNumber>
<MachineId>00000000-0000-0000-0000-000000718730</MachineId>
<UnitId>2893597</UnitId>
</Metadata>
</Equipment>
<Equipment>
<EquipmentHeader>
<OEMName>Husqvarna</OEMName>
<Model>FS 400 LV</Model>
<SerialNumber>965148202</SerialNumber>
<PIN>965148202</PIN>
</EquipmentHeader>
<Location datetime="2021-08-04T11:55:17Z">
<Latitude>57.0477583</Latitude>
<Longitude>9.9474033</Longitude>
</Location>
<CumulativeOperatingHours datetime="2021-07-29T11:46:03Z">
<Hour>64.98</Hour>
</CumulativeOperatingHours>
<Metadata>
<TelematicSerialNumber>BT-2159-003003391</TelematicSerialNumber>
<MachineId>cbe341fb-50ef-41ea-a878-f1f0726518e9</MachineId>
</Metadata>
</Equipment>
</Fleet>
Response field summary
EquipmentHeader - header data
Name | Data type | Notes |
---|---|---|
UnitInstallDateTime | DateTime | Telematics unit installation date. This date and time describes when the telematics unit was installed on the asset. This field is optional, and if blank, it is assumed that the telematics unit was installed when the machine was built. |
OEMName | String | Equipment make |
Model | String | The model or series of the equipment. The field is optional and if this data element is unavailable, then it is populated with blanks. |
EquipmentID | String | The customer's machine name is mapped to this field. The end-user shall provide this information to the telematics provider during fleet registration. Because this field is defined by the end-user, it is not a unique identifier. This field is optional. |
SerialNumber | String | The serial number identifies the specific instance of the asset for those that are not identified by a PIN or a VIN. If the equipment serial number doesn't exist we map the telematic serial number to provide backward compatibility. This field is optional. If a PIN or VIN is assigned to the machine, the PIN or VIN shall be used in place of the serial number. |
PIN | String | OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles. |
Location - The last known equipment location
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time recorded when the asset was at the described location. |
Latitude | Decimal (signed, six digits of precision) | The latitude is expressed in the range from -90.000000° to +90.000000°. The latitude at the equator has a value of 0° Latitudes north of the equator are represented as positive numbers; whereas those south, by negative numbers. |
Longitude | Decimal (signed, six digits of precision) | The longitude is expressed in the range from -180.000000° to +180.000000°. The longitude at the prime meridian has a value of 0° Longitudes to the east are represented as positive numbers; whereas those to the west, by negative numbers. |
Altitude | Decimal | Distance above mean sea level of the asset's location. Altitude is reported in metres. This field is optional. |
AltitudeUnits | String | Mandatory field if the altitude is included in the response. It should have the value “metre”. |
CumulativeOperatingHours - the current lifetime total cumulative operating hours of the equipment
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the operating hours value of the equipment was recorded. |
Hour | Decimal | The cumulative quantity of time during which the asset has been operating. It is typically the duration of time the machine’s engine has been running, as reflected by the value of the hourmeter on the machine. |
FuelUsed - cumulative fuel used
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
FuelUnits | String | Mandatory field if the fuel used is included in the response. It should have the value “litre”. |
FuelConsumed | Integer (unsigned) | The amount of fuel used. |
FuelUsedLast24 - fuel used in the preceding 24 hours
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the 24h period ended. |
FuelUnits | String | Mandatory field if the fuel used is included in the response. It should have the value “litre”. |
FuelConsumed | Integer (unsigned) | The amount of fuel used during 24h period that ended at the specified date and time. The period refers to the elapsed clock time, not to machine operation time. |
Distance - cumulative distance travelled
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
OdometerUnits | String | Mandatory field if the Odometer value is included in the response. It should have the value “kilometre”. |
Odometer | Decimal (signed, one digit of precision) | Cumulative distance travelled as of the specified date and time. |
CumulativeIdleHours - the current lifetime total cumulative idle operating hours of the equipment
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Hour | Decimal (eight digits in length with 2 digits of precision) | The cumulative quantity of time during which the asset has been in the idle state. |
FuelRemaining - fuel remaining ratio
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Percent | Decimal (with 2 digits of precision) | The percentage of fuel remaining in the fuel tank. |
FuelTankCapacityUnits | String | Mandatory field if the FuelTankCapacity value is included in the response. It should have the value “litre”. |
FuelTankCapacity | Integer (unsigned) | Fuel tank capacity. |
DEFRemaining - Diesel exhaust fluid remaining ratio
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Percent | Decimal (with 2 digits of precision) | The percentage of DEF remaining in the DEF tank. |
DEFTankCapacityUnits | String | Mandatory field if the DEFTankCapacity value is included in the response. It should have the value “litre”. |
DEFTankCapacity | Decimal (with 2 digits of precision) | DEF tank capacity. |
EngineStatus - an indicator of the current status of the equipment engine running state
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
EngineNumber | String | The engine number is by the OEM representing the unique engine in the construction machine. |
Running | Boolean | The running state of the engine as of the specified date and time. False value indicates not running and true indicates running state. |
CumulativePowerTakeOffHours - cumulative power take-off hours
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Hour | Decimal (eight digits in length with 2 digits of precision) | Current lifetime total power take-off hours of the machine. |
AverageLoadFactorLast24 - average Daily Engine Load Factor
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Percent | Decimal (with 2 digits of precision) | This field indicates the average load factor during a 24h period of machine life (whether or not operating) as of the specified data and time. The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output. |
MaximumSpeedLast24 - peak daily speed
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
SpeedUnits | String | Mandatory field if the Speed value is included in the response. Speed is to be expressed as kilometres per hour or metres per minute. |
Speed | Decimal | Peak speed of a 24h period. |
CumulativeLoadCount - cumulative load count
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the equipment recorded a completed load. |
Count | Integer (unsigned) | The number of loads that has been performed cumulatively by the equipment as of the specified date and time. |
CumulativePayloadTotals - cumulative payload total
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the equipment recorded the cumulative payload. |
PayloadUnits | String | Mandatory field if the Payload value is included in the response. The field should have the value "kilogram". |
Payload | Decimal | The quantity of payload that has been moved cumulatively by the machine as of the specified date and time. |
CumulativeActiveRegenerationHours - cumulative non-productive regeneration hours
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the equipment recorded the value for cumulative non-productive regeneration hours. |
Hour | Decimal (eight digits in length with 2 digits of precision) | The current lifetime total non-productive regeneration hours of the equipment. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process. |
CumulativeIdleNonOperatingHours - cumulative idle non-operating hours
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the idle non-operating hours. |
Hour | Decimal (eight digits in length with 2 digits of precision) | Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated). |
Single-element snapshot
URL:/Fleet/Equipment/ID/{OEM ISO identifier}
Single-element snapshot provides the snapshot of the latest available telematics data for a single equipment identified by the OEM ISO identifier parameter. Response format is the same as for Fleet snapshot.
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
Sample response
?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Fleet xmlns="http://standards.iso.org/iso/15143/-3" version="0">
<Equipment>
<EquipmentHeader>
<OEMName>Kramer</OEMName>
<Model>4095</Model>
<EquipmentID>K4095-1</EquipmentID>
<SerialNumber>453020511</SerialNumber>
<PIN>453020511</PIN>
</EquipmentHeader>
<Location datetime="2021-08-04T11:57:10Z">
<Latitude>39.71107699999882</Latitude>
<Longitude>-104.79963966666429</Longitude>
</Location>
<CumulativeOperatingHours datetime="2021-08-04T11:57:30Z">
<Hour>1444.60</Hour>
</CumulativeOperatingHours>
<Distance datetime="2021-08-04T11:57:10Z">
<OdometerUnits>kilometre</OdometerUnits>
<Odometer>1806.00</Odometer>
</Distance>
<EngineStatus datetime="2021-08-04T11:57:10Z">
<EngineNumber>N/A</EngineNumber>
<Running>false</Running>
</EngineStatus>
<FuelUsed datetime="2021-08-04T11:57:30Z">
<FuelUnits>litre</FuelUnits>
<FuelConsumed>4091</FuelConsumed>
</FuelUsed>
<Metadata>
<TelematicSerialNumber>927096</TelematicSerialNumber>
<MachineId>00000000-0000-0000-0000-000000718730</MachineId>
<UnitId>2893597</UnitId>
</Metadata>
</Equipment>
</Fleet>
Timeseries endpoints
The timeseries endpoints provide a single dataseries for a single machine back in time.
Subscription requirement
The timeseries endpoints is only available to customers on the Insight subscription package!
Location
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/Locations/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<LocationMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/Locations/2021-08-01T00:00/2021-08-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/Locations/2021-08-01T00:00/2021-08-05T00:00/1
</href>
</Links>
<Location datetime="2021-08-01T09:15:47Z">
<Latitude>41.176966</Latitude>
<Longitude>-85.089045</Longitude>
<Altitude>250.0</Altitude>
<AltitudeUnits>metre</AltitudeUnits>
</Location>
<Location datetime="2021-08-01T09:30:47Z">
<Latitude>41.176938</Latitude>
<Longitude>-85.089035</Longitude>
<Altitude>250.0</Altitude>
<AltitudeUnits>metre</AltitudeUnits>
</Location>
</LocationMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time recorded when the asset was at the described location. |
Latitude | Decimal (signed, six digits of precision) | The latitude is expressed in the range from -90.000000° to +90.000000°. The latitude at the equator has a value of 0° Latitudes north of the equator are represented as positive numbers; whereas those south, by negative numbers. |
Longitude | Decimal (signed, six digits of precision) | The longitude is expressed in the range from -180.000000° to +180.000000°. The longitude at the prime meridian has a value of 0° Longitudes to the east are represented as positive numbers; whereas those to the west, by negative numbers. |
Altitude | Decimal | Distance above mean sea level of the asset's location. Altitude is reported in metres. This field is optional. |
AltitudeUnits | String | Mandatory field if the altitude is included in the response. It should have the value “metre”. |
CumulativeOperatingHours
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativeOperatingHours/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativeOperatingHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/CumulativeOperatingHours/2021-08-01T00:00/2021-08-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/CumulativeOperatingHours/2021-08-01T00:00/2021-08-05T00:00/1
</href>
</Links>
<CumulativeOperatingHours datetime="2021-08-04T23:51:24Z">
<Hour>2253.2</Hour>
</CumulativeOperatingHours>
<CumulativeOperatingHours datetime="2021-08-04T23:36:24Z">
<Hour>2253.2</Hour>
</CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the operating hours value of the equipment was recorded. |
Hour | Decimal | The cumulative quantity of time during which the asset has been operating. It is typically the duration of time the machine’s engine has been running, as reflected by the value of the hourmeter on the machine. |
CumulativeFuelUsed
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativeFuelUsed/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/CumulativeFuelUsed/2021-04-20T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/CumulativeFuelUsed/2021-04-20T00:00/2021-05-05T00:00/1
</href>
</Links>
<FuelUsed datetime="2021-04-30T15:44:26.001Z">
<FuelUnits>litre</FuelUnits>
<FuelConsumed>759</FuelConsumed>
</FuelUsed>
<FuelUsed datetime="2021-04-30T15:40:28Z">
<FuelUnits>litre</FuelUnits>
<FuelConsumed>759</FuelConsumed>
</FuelUsed>
</FuelUsedMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
FuelUnits | String | Mandatory field if the fuel used is included in the response. It should have the value “litre”. |
FuelConsumed | Integer (unsigned) | The amount of fuel used. |
FuelUsedInThePreceding24Hours
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/FuelUsedInThePreceding24Hours/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/FuelUsedInThePreceding24Hours/2021-02-20T00:00/2021-08-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/FuelUsedInThePreceding24Hours/2021-02-20T00:00/2021-08-05T00:00/1
</href>
</Links>
<FuelUsed datetime="2021-03-31T22:59:59Z">
<FuelUnits>litre</FuelUnits>
<FuelConsumed>15</FuelConsumed>
</FuelUsed>
<FuelUsed datetime="2021-03-30T22:59:59Z">
<FuelUnits>litre</FuelUnits>
<FuelConsumed>13</FuelConsumed>
</FuelUsed>
</FuelUsedMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datatype | DateTime | The date and time indicate when the 24h period ended. |
FuelUnits | String | Mandatory field if the fuel used is included in the response. It should have the value “litre”. |
FuelConsumed | Integer (unsigned) | The amount of fuel used during 24h period that ended at the specified date and time. The period refers to the elapsed clock time, not to machine operation time. |
Distance
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/Distance/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DistanceMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/Distance/2021-04-20T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/Distance/2021-04-20T00:00/2021-05-05T00:00/1
</href>
</Links>
<Distance datetime="2021-04-30T23:53:04Z">
<OdometerUnits>kilometre</OdometerUnits>
<Odometer>7.4</Odometer>
</Distance>
<Distance datetime="2021-04-30T23:38:04Z">
<OdometerUnits>kilometre</OdometerUnits>
<Odometer>7.4</Odometer>
</Distance>
</DistanceMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
OdometerUnits | String | Mandatory field if the Odometer value is included in the response. It should have the value “kilometre”. |
Odometer | Decimal (signed, one digit of precision) | Cumulative distance travelled as of the specified date and time. |
CumulativeIdleHours
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativeIdleHours/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativeIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/CumulativeIdleHours/2021-04-20T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeIdleHours/2021-04-20T00:00/2021-05-05T00:00/1
</href>
</Links>
<CumulativeIdleHours datetime="2021-04-30T23:48:56Z">
<Hour>1072.15</Hour>
</CumulativeIdleHours>
<CumulativeIdleHours datetime="2021-04-30T23:33:56Z">
<Hour>1071.50</Hour>
</CumulativeIdleHours>
</CumulativeIdleHoursMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Hour | Decimal (eight digits in length with 2 digits of precision) | The cumulative quantity of time during which the asset has been in the idle state. |
PeakDailySpeed
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/PeakDailySpeed/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PeakDailySpeedMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/PeakDailySpeed/2021-04-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/PeakDailySpeed/2021-04-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Speed datetime="2021-04-08T22:00:00Z">
<SpeedUnits>kilometres per hour</SpeedUnits>
<Speed>0.0</Speed>
</Speed>
<Speed datetime="2021-04-07T22:00:00Z">
<SpeedUnits>kilometres per hour</SpeedUnits>
<Speed>7.2</Speed>
</Speed>
</PeakDailySpeedMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
SpeedUnits | String | Mandatory field if the Speed value is included in the response. Speed is to be expressed as kilometres per hour or metres per minute. |
Speed | Decimal | Peak speed of a 24h period. |
CumulativeLoadCount
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativeLoadCount/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativeLoadCountMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeLoadCount/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeLoadCount/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<CumulativeLoadCount datetime="2021-08-11T11:34:08.857650Z">
<Count>123</Count>
</CumulativeLoadCount>
</CumulativeLoadCountMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the equipment recorded a completed load. |
Count | Integer (unsigned) | The number of loads that has been performed cumulatively by the equipment as of the specified date and time. |
CumulativePayloadTotals
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativePayloadTotals/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativePayloadTotalMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativePayloadTotals/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativePayloadTotals/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<CumulativePayloadTotals datetime="2021-08-11T12:48:36.584374Z">
<PayloadUnits>kilogram</PayloadUnits>
<Payload>1024</Payload>
</CumulativePayloadTotals>
</CumulativePayloadTotalMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the equipment recorded the cumulative payload. |
PayloadUnits | String | Mandatory field if the Payload value is included in the response. The field should have the value "kilogram". |
Payload | Decimal | The quantity of payload that has been moved cumulatively by the machine as of the specified date and time. |
CumulativeActiveRegenerationHours
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativeActiveRegenerationHours/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativeActiveRegenerationHourMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeActiveRegenerationHours/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeActiveRegenerationHours/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<CumulativeActiveRegenerationHours datetime="2021-01-31T22:59:59Z">
<Hour>318.1</Hour>
</CumulativeActiveRegenerationHours>
<CumulativeActiveRegenerationHours datetime="2021-05-01T22:59:59Z">
<Hour>336.5</Hour>
</CumulativeActiveRegenerationHours>
</CumulativeActiveRegenerationHourMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the equipment recorded the value for cumulative non-productive regeneration hours. |
Hour | Decimal (eight digits in length with 2 digits of precision) | The current lifetime total non-productive regeneration hours of the equipment. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process. |
CumulativeNonProductiveIdleHours
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativeNonProductiveIdleHours/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativeNonproductiveIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeNonProductiveIdleHours/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativeNonProductiveIdleHours/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<CumulativeNonproductiveIdleHours datetime="2021-01-31T22:59:59Z">
<Hour>318.1</Hour>
</CumulativeNonproductiveIdleHours>
<CumulativeNonproductiveIdleHours datetime="2021-05-03T22:59:59Z">
<Hour>336.5</Hour>
</CumulativeNonproductiveIdleHours>
</CumulativeNonproductiveIdleHoursMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the idle non-operating hours. |
Hour | Decimal (eight digits in length with 2 digits of precision) | Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated). |
Faults
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/Faults/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>https://dev.iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/Faults/2020-07-01T00:00:00Z/2021-08-01T00:00:00Z/1</href>
</Links>
<Links>
<rel>last</rel>
<href>https://dev.iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/Faults/2020-07-01T00:00:00Z/2021-08-01T00:00:00Z/1</href>
</Links>
<FaultCode datetime="2021-07-06T15:51:28.003Z">
<CodeIdentifier>1231-9</CodeIdentifier>
<CodeSeverity>10</CodeSeverity>
<CodeSource>61</CodeSource>
</FaultCode>
<FaultCode datetime="2021-07-28T06:02:46.002Z">
<CodeIdentifier>1231-9</CodeIdentifier>
<CodeSeverity>10</CodeSeverity>
<CodeSource>61</CodeSource>
</FaultCode>
</DiagnosticTroubleCode>
Response field summary
Name | Data Type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the given code identifier occurred on the machine. |
CodeIdentifier | String | The diagnostic trouble code identifier specifies the identification for the code that occurred at a specific data and time. |
CodeSeverity | String | The code severity is the severity descriptor of the specific code identifier that occurred. |
CodeSource | String | The description of code source indicates the machine controller (e.g. ECU) that generated the code on the machine. |
AverageDailyEngineLoadFactors
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/AverageDailyEngineLoadFactors/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AverageLoadFactorLast24 xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/AverageDailyEngineLoadFactors/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/AverageDailyEngineLoadFactors/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<LoadFactor datetime="2021-08-12T12:03:25.949845Z">
<Percent>32</Percent>
</LoadFactor>
</AverageLoadFactorLast24>
Response field summary
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Percent | Decimal (with 2 digits of precision) | This field indicates the average load factor during a 24h period of machine life (whether or not operating) as of the specified data and time. The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output. |
CumulativePowerTakeOffHours
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/CumulativePowerTakeOffHours/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CumulativePowerTakeOffHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativePowerTakeOffHours/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/CumulativePowerTakeOffHours/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<CumulativePowerTakeOffHours datetime="2021-04-13T13:54:41.001Z">
<Hour>0.0</Hour>
</CumulativePowerTakeOffHours>
<CumulativePowerTakeOffHours datetime="2021-04-13T13:54:34Z">
<Hour>0.5</Hour>
</CumulativePowerTakeOffHours>
</CumulativePowerTakeOffHoursMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Hour | Decimal (eight digits in length with 2 digits of precision) | Current lifetime total power take-off hours of the machine. |
DEFRemaining
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/DEFRemaining/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DEFRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/DEFRemaining/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/DEFRemaining/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<DEFRemaining datetime="2021-03-29T16:40:15Z">
<Percent>51.20</Percent>
</DEFRemaining>
<DEFRemaining datetime="2021-03-29T16:39:13Z">
<Percent>51.21</Percent>
</DEFRemaining>
</DEFRemainingMessages>
Response field summary
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Percent | Decimal (with 2 digits of precision) | The percentage of DEF remaining in the DEF tank. |
DEFTankCapacityUnits | String | Mandatory field if the DEFTankCapacity value is included in the response. It should have the value “litre”. |
DEFTankCapacity | Decimal (with 2 digits of precision) | DEF tank capacity. |
FuelRemainingRatio
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/FuelRemainingRatio/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FuelRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/FuelRemainingRatio/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/FuelRemainingRatio/2021-01-01T00:00/2021-05-05T00:00/1
</href>
</Links>
<FuelRemaining datetime="2021-02-28T10:59:55Z">
<Percent>83.20</Percent>
<FuelTankCapacityUnits>litre</FuelTankCapacityUnits>
<FuelTankCapacity>64</FuelTankCapacity>
</FuelRemaining>
<FuelRemaining datetime="2021-02-28T10:58:55.002Z">
<Percent>83.20</Percent>
<FuelTankCapacityUnits>litre</FuelTankCapacityUnits>
<FuelTankCapacity>64</FuelTankCapacity>
</FuelRemaining>
</FuelRemainingMessages>
Response field summary
Name | Date type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Percent | Decimal (with 2 digits of precision) | The percentage of fuel remaining in the fuel tank. |
FuelTankCapacityUnits | String | Mandatory field if the FuelTankCapacity value is included in the response. It should have the value “litre”. |
FuelTankCapacity | Integer (unsigned) | Fuel tank capacity. |
EngineCondition
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/EngineCondition/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<EngineStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/EngineCondition/2021-05-01T00:00/2021-06-05T00:00/1
</href>
</Links>
<Links>
<rel>last</rel>
<href>
https://iris.trackunit.com/public/api/aemp/v215143/-3/Fleet/Equipment/ID/0300000000/EngineCondition/2021-05-01T00:00/2021-06-05T00:00/1
</href>
</Links>
<EngineStatus datetime="2021-05-31T23:48:49Z">
<Running>false</Running>
</EngineStatus>
<EngineStatus datetime="2021-05-31T23:33:49Z">
<Running>true</Running>
</EngineStatus>
</EngineStatusMessages>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
EngineNumber | String | The engine number is by the OEM representing the unique engine in the construction machine. |
Running | Boolean | The running state of the engine as of the specified date and time. False value indicates not running and true indicates running state. |
Machine Insigths - Timeseries
Similar to Fleet Snapshot, our Timeseries endpoints allow to retrieve Machine Insights that do not fit in the ISO standard schema. While in Fleet snapshot this is enabled by a request parameter, Timeseries data requires separate endpoint.
URL:/Fleet/Equipment/ID/{OEM ISO identifier}/{timeSeriesType}/{startDate}/{endDate}/{pageNumber}
Request summary
- OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.
- timeSeriesType - name of the Machine Insight as listed in Trackunit Data Model if it's not covered by ISO standard. The exact values can be found in AEMP ISO 15143-3 API
- startDate - Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example: 2020-01-19T16:22:20Z).
- endDate - End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard (for example example 2020-01-20T00:22:20Z).
- pageNumber - Requested page number. The only supported value is 1
Sample response for BatteryPotential Machine Insight
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MachineInsightTimeseries
xmlns="http://standards.iso.org/iso/15143/-3">
<Links>
<rel>self</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/BatteryPotential/2021-08-24T06:00:00Z/2021-08-24T06:15:00Z/1</href>
</Links>
<Links>
<rel>last</rel>
<href>https://iris.trackunit.com/public/api/aemp/v2/15143/-3/Fleet/Equipment/ID/0300000000/BatteryPotential/2021-08-24T06:00:00Z/2021-08-24T06:15:00Z/1</href>
</Links>
<BatteryPotential datetime="2021-08-24T06:14:53Z">
<BatteryPotential>13.0</BatteryPotential>
<Value>13.0</Value>
</BatteryPotential>
<BatteryPotential datetime="2021-08-24T06:12:19Z">
<BatteryPotential>13.1</BatteryPotential>
<Value>13.1</Value>
</BatteryPotential>
<BatteryPotential datetime="2021-08-24T06:08:12Z">
<BatteryPotential>13.3</BatteryPotential>
<Value>13.3</Value>
</BatteryPotential>
<BatteryPotential datetime="2021-08-24T06:01:47Z">
<BatteryPotential>13.6</BatteryPotential>
<Value>13.6</Value>
</BatteryPotential>
</MachineInsightTimeseries>
Response field summary
Name | Data type | Notes |
---|---|---|
datetime | DateTime | The date and time indicate when the measurement has been recorded. |
Value | Decimal | Measured Machine Insight value. Value is deprecated and may be removed in future releases. Specific values like BatteryPotential should be used. |
Specific named value like "BatteryPotential" | Decimal / String / Boolean | https://app.swaggerhub.com/apis-docs/trackunit.com/aemp |
Changes from previous version.
EquipmentID now contains "Display name" set from Manager. In the previous version EquipmentID was mapped from imported ISO 15143-feeds.
In the previous version, equipment from imported ISO 15143-feeds had their serial numbers prefixed for internal uniqueness. In the current version the serial numbers are no longer prefixed. The prefixed version of the serial number can still be found in metadata section.
Trackunit Kin data is now included in the API response. EquipmentHeader contains asset data on which the Kin tag is onboarded. Metadata consists of Kin’s serial number and asset ID (as MachineId field).
Updated about 2 months ago