API docs by Redocly

Proemion ISO-15143-3 (AEMP) (11.1.1887)

Download OpenAPI specification:

An implementation of ISO-15143-3 standard.

The API described here is being actively developed. We reserve the right to change it at any time. We will send notifications of API changes in advance.

Contract

If you have any concerns, require a clarification or found a problem with this API, please raise a ticket at the Customer Support Center.

General properties

Access

Protocol: HTTPS, REST.

Authorization: OAuth 2.0, user-based (please see the Authentication endpoint for details).

Response type: XML (JSON may be supported in the future).

NOTE: Customers with white label URL should use their custom URL, e.g. https://customURL/aemp, instead of https://dataportal.proemion.com/aemp as a base URL. Example: https://portal.merino-op.com/aemp

Identifiers / Request parameters

ISO-15143-3 defines two identifiers for machines

  1. VIN/PIN - recommended
  2. MakeModelSerial - optional

While our API supports both identifiers, it is highly recommended to use VIN or PIN since it is far less susceptible to changes.

An OEM may configure both VIN/PIN and MakeModelSerial as identifiers to ensure compatibility with any identifier a consumer may use. Find more information on the identifiers in the DataPortal User Manual.

For machines to be listed here on the DataPlatform and to be able to retrieve them, they have to either have

  1. a VIN or PIN set.
  2. all of OEM name (Make), Model name (Model) and machine serial number (Serial) set.

PIN / VIN: To resolve any collisions between those two, PIN is considered before VIN. The values are case-insensitive (and, in the responses, all their letters will be uppercase).

MakeModelSerial: The values are case-sensitive.

Date and time: A 1-second-precision ISO-8601 timestamp format with the UTC time zone is expected in the requests and returned in the responses (i.e. yyyy-MM-ddThh:mm:ssZ).

Discoverability

The returned resources will contain a collection of <Links> elements which reference self and related resource endpoints (e.g. prev and next in case of paged listings).

The URLs given in links are relative to the API's root URL and start with a backslash /, e.g. /Fleet/1.

Performance

Paging

The page size being used cannot be specified in the request, but rather is tuned by API maintainers to provide the optimal performance (which means it can change in the future).

The paged responses contain no information on the total number of elements in the listing. The presence of next link indicates that at least one more element was available at the moment of generating that response.

Request throttling

This API might be subject to request throttling and respond with HTTP 429 in the future.

Supported metrics

We support the following subset of metrics defined by the ISO-15143-3 specification. In general, they will be present in the returned snapshots and timeseries if they are configured for a specific equipment (and have been reported at least once in the requested time-range).

  • AverageDailyEngineLoadFactors
    • can be calculated by DataPlatform or mapped directly
    • PDC metric key value.common.engine.loadfactor.last.24hr is used for direct mapping takes precedence
    • PDC metric key value.common.engine.loadfactor.current is used for calculated values
    • for snapshots the average engine load in last 24h is returned
    • for timeseries each returned datapoint represents average engine load during a 24h period ending at UTC midnight
    • PDC unit used predefined.unit.PERCENT
    • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
  • CumulativeOperatingHours (Operating Hours)
    • PDC metric key used value.common.machine.hours.operation.total
    • PDC unit used predefined.unit.time.HOUR
  • CumulativePowerTakeOffHours (Cumulative Power Take-Off Hours)
    • PDC metric key used value.common.machine.hours.pto.total
    • PDC unit used predefined.unit.time.HOUR
  • CumulativeActiveRegenerationHours (Cumulative Non-Productive Regeneration Hours)
    • PDC metric key used value.common.engine.hours.regeneration.total
    • PDC unit used predefined.unit.time.HOUR
  • CumulativeIdleHours (Cumulative Idle Operating Hours)
    • PDC metric key used value.common.machine.hours.oem.specific.total
    • PDC unit used predefined.unit.time.HOUR
  • CumulativeNonProductiveIdleHours (Cumulative Idle Non-Operating Hours)
    • PDC metric key used value.common.machine.hours.idle.total
    • PDC unit used predefined.unit.time.HOUR
  • Distance (Cumulative Distance Travelled)
    • PDC metric key used value.common.machine.distance.total
    • PDC unit used predefined.unit.length.KILOMETER
  • EngineStatus (Engine Condition)
    • in snapshots only
    • the EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:
      • both underlying metrics have to be configured and present
      • the Running value drives the datetime
    • has a timeseries counterpart (EngineCondition)
    • for EngineNumber
      • PDC metric key used value.common.engine.identification.serialnumber
      • PDC unit used predefined.unit.TEXT
    • for EngineRunning
      • PDC metric key used value.common.engine.state
      • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
  • EngineCondition (Engine Condition)
    • in timeseries only
    • the EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:
      • both underlying metrics have to be configured and present
      • the Running value drives the datetime in each datapoint
      • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range
    • has a snapshots counterpart (EngineStatus)
    • for EngineNumber
      • PDC metric key used value.common.engine.identification.serialnumber
      • PDC unit used predefined.unit.TEXT
    • for EngineRunning
      • PDC metric key used value.common.engine.state
      • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
  • FuelRemainingRatio
    • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
    • PDC metric key used value.common.engine.fuel.level
    • PDC unit used predefined.unit.PERCENT
  • CumulativeFuelUsed (Cumulative Fuel Used)
    • PDC metric key used value.common.engine.fuel.used.total
    • PDC unit used predefined.unit.volume.LITER
  • CumulativeLoadCount (Cumulative Load Count)
    • PDC metric key used value.common.machine.load.count.total
    • PDC unit used predefined.unit.NUMBER
  • CumulativePayloadTotals (Cumulative Payload Total)
    • PDC metric key used value.common.machine.load.total
    • PDC unit used predefined.unit.mass.KILOGRAM
  • Locations (Last Known Location)
    • Latitude - from Geo dataset
    • Longitude - from Geo dataset
    • Altitude - from Geo dataset
      • unit used predefined.unit.length.METER
  • PeakDailySpeed (Peak Daily Speed)
    • for snapshots, the maximum speed achieved in the last 24h is returned
    • for timeseries, each returned datapoint represents maximum speed during a 24h period ending at UTC midnight
    • PDC metric key used value.common.machine.speed
    • PDC unit used predefined.unit.speed.KILOMETERS_PER_HOUR
  • DEFRemaining (DEF Remaining Ratio)
    • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
    • PDC metric key used value.common.engine.def.level
    • PDC unit used predefined.unit.PERCENT
  • Faults (also known as DiagnosticTroubleCodes, FaultCodes)
    • CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}
  • CautionCodes
    • in time-series only
    • CautionMessages contains a list of CautionDescription items, populated by signals with PDC valueDefinition category StateSignal and attribute machineError=true.
    • Each CautionDescription represents the number of a code that occurred at a specific date and time.
    • Identifier and Description are taken from aempCautionCode section in the PDC. If it is absent then the state value and description are used.
  • SwitchStatus (Digital Input State)
    • in time-series only
    • SwitchStatusMessages contains a list of SwitchStatus items
    • Each SwitchStatus represents a change of status IsOn of a specific switch SwitchNumber that occurred at a specific date and time.
    • PDC metric key used value.common.machine.inputs.digital.[number] where number defines a switch number.
    • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true

Security

We strive to follow the latest security best-practices. As such our API is only available via HTTPS with TLS no older than version 1.2.

Errors

Error response structure

Each error response has the following structure.

<error xmlns="urn:pe:iso15143">
    <code>404</code>
    <message>Requested resource not found</message>
    <logId>2342221-321df-342fds21</logId>
</error>
  • code: HTTP response code.
  • message: Error message.
  • logid: A unique alpha-numeric identifier to track an error event in our logs.

Common error responses

400 (Bad request)

Cause: Invalid parameters in the request. For example, when a String is passed for an Integer/Long parameter, or an ISO-8601 timestamp cannot be parsed.

Example:

<error xmlns="urn:pe:iso15143">
    <code>400</code>
    <message>Cannot cast '12acd' to type class java.lang.Long</message>
    <logId>2342221-321df-342fds22</logId>
</error>

403 (Forbidden)

Cause: Insufficient permissions for the current user to access a given resource.

Example:

<error xmlns="urn:pe:iso15143">
    <code>403</code>
    <message>Not entitled for this request, please contact customer support</message>
    <logId>2342221-321df-342fds24</logId>
</error>

Auth

Authentication endpoints

Obtain an access token for a user (password grant)

Endpoint to authenticate the user and obtain an access token for accessing any entitled enpoints. This follows the OAuth 2.0 password based grant. Please note that a successful response from this endpoint is the only one of type application/json, as required by the OAuth 2.0 specification. The unsuccessful responses maintain the application/xml type for consistency with the rest of AEMP API.

The same user may successfully log-in once per second, on average. Occasional log-in bursts are allowed, and the maximum lock-out time is 2 seconds. Failed login attempts are throttled more aggressively, using an exponentially increasing lock-out times.

Request Body schema: application/x-www-form-urlencoded
required
username
required
string

Name of the user

password
required
string

Password of the user

grant_type
required
string

OAuth grant type. Only 'password' is supported.

client_id
string

Name of your application for troubleshooting and migration purposes.

Responses

Response samples

Content type
application/json
{
  • "access_token": "dfjldf93lkj4398df.kf9834ldfo3.j43fdkd83ldeld",
  • "expires_in": 3600,
  • "token_type": "bearer"
}

Obtain an access token for a client (client_credentials)

Endpoint to support OAuth 2.0 compatible user and client authentication.

The endpoint also supports HTTP Basic authentication scheme.

Obtain an access token for a client. Follows the OAuth 2.0 "client_credentials" grant scheme.

The same client may successfully log-in once per second, on average. Occasional log-in bursts are allowed, and the maximum lock-out time is 2 seconds. Failed login attempts are throttled more aggressively, using an exponentially increasing lock-out times.

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string

OAuth grant type. Only 'client_credentials' is supported.

client_id
required
string

Client identifier

client_secret
required
string

Client secret

Responses

Response samples

Content type
application/json
{
  • "access_token": "dfjldf93lkj4398df.kf9834ldfo3.j43fdkd83ldeld",
  • "expires_in": 3600,
  • "scope": "read,write",
  • "token_type": "bearer"
}

Fleet snapshots

Endpoints to retrieve snapshots of an entire Fleet or a specific Equipment.

Get first page of the Equipment listing

Get the first page of the Equipment listing.

Authorizations:
oauth2

Responses

Response samples

Content type
application/xml
<Fleet xmlns="http://standards.iso.org/iso/15143/-3" version="1"
       snapshotTime="2018-09-04T12:34:56Z">
    <Links>
        <rel>self</rel>
        <href>/Fleet/0</href>
    </Links>
    <Links>
        <rel>next</rel>
        <href>/Fleet/1</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93720</PIN>
        </EquipmentHeader>
        <AverageLoadFactorLast24 datetime="2018-09-04T00:00:00Z">
            <Percent>65.25</Percent>
        </AverageLoadFactorLast24>
        <CumulativeActiveRegenerationHours datetime="2018-09-04T12:34:52Z">
            <Hour>5.30</Hour>
        </CumulativeActiveRegenerationHours>
        <CumulativeIdleHours datetime="2018-09-04T12:34:50Z">
            <Hour>3.31</Hour>
        </CumulativeIdleHours>
        <CumulativeIdleNonOperatingHours datetime="2018-09-04T11:34:33Z">
            <Hour>22.02</Hour>
        </CumulativeIdleNonOperatingHours>
        <CumulativeLoadCount datetime="2018-09-04T01:34:33Z">
            <Count>31</Count>
        </CumulativeLoadCount>
        <CumulativeOperatingHours datetime="2018-09-04T10:31:51Z">
            <Hour>13.53</Hour>
        </CumulativeOperatingHours>
        <CumulativePowerTakeOffHours datetime="2018-09-04T12:34:52Z">
            <Hour>100.04</Hour>
        </CumulativePowerTakeOffHours>
        <CumulativePayloadTotals datetime="2018-09-04T12:35:07Z">
            <PayloadUnits>kilogram</PayloadUnits>
            <Payload>4780.5</Payload>
        </CumulativePayloadTotals>
        <DEFRemaining datetime="2018-09-04T02:03:23Z">
            <Percent>13.00</Percent>
        </DEFRemaining>
        <Distance datetime="2018-09-04T06:14:44Z">
            <OdometerUnits>kilometre</OdometerUnits>
            <Odometer>12.1</Odometer>
        </Distance>
        <EngineStatus datetime="2018-09-04T10:19:11Z">
            <EngineNumber>abc123</EngineNumber>
            <Running>true</Running>
        </EngineStatus>
        <FuelUsed datetime="2018-09-04T09:38:07Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>1</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93721</PIN>
        </EquipmentHeader>
        <AverageLoadFactorLast24 datetime="2018-09-04T00:00:00Z">
            <Percent>55.02</Percent>
        </AverageLoadFactorLast24>
        <CumulativeActiveRegenerationHours datetime="2018-09-04T12:34:52Z">
            <Hour>5.30</Hour>
        </CumulativeActiveRegenerationHours>
        <CumulativeIdleHours datetime="2018-09-04T12:34:50Z">
            <Hour>3.31</Hour>
        </CumulativeIdleHours>
        <CumulativeIdleNonOperatingHours datetime="2018-09-04T11:34:33Z">
            <Hour>22.02</Hour>
        </CumulativeIdleNonOperatingHours>
        <CumulativeLoadCount datetime="2018-09-04T01:34:33Z">
            <Count>31</Count>
        </CumulativeLoadCount>
        <CumulativeOperatingHours datetime="2018-09-04T10:31:51Z">
            <Hour>13.53</Hour>
        </CumulativeOperatingHours>
        <CumulativePowerTakeOffHours datetime="2018-09-04T12:34:52Z">
            <Hour>100.04</Hour>
        </CumulativePowerTakeOffHours>
        <CumulativePayloadTotals datetime="2018-09-04T12:35:07Z">
            <PayloadUnits>kilogram</PayloadUnits>
            <Payload>6710.8</Payload>
        </CumulativePayloadTotals>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93722</PIN>
        </EquipmentHeader>
        <DEFRemaining datetime="2018-09-04T02:03:23Z">
            <Percent>13.00</Percent>
        </DEFRemaining>
        <Distance datetime="2018-09-04T06:14:44Z">
            <OdometerUnits>kilometre</OdometerUnits>
            <Odometer>12.1</Odometer>
        </Distance>
        <EngineStatus datetime="2018-09-04T10:19:11Z">
            <EngineNumber>abc123</EngineNumber>
            <Running>true</Running>
        </EngineStatus>
        <FuelUsed datetime="2018-09-04T09:38:07Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>1</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
</Fleet>

Get a specific page of the Equipment listing

Get a specific page of the Equipment listing.

Authorizations:
oauth2
path Parameters
page
required
number

Index of the page (0-based)

Responses

Response samples

Content type
application/xml
<Fleet xmlns="http://standards.iso.org/iso/15143/-3" version="1"
       snapshotTime="2018-09-04T12:34:56Z">
    <Links>
        <rel>self</rel>
        <href>/Fleet/0</href>
    </Links>
    <Links>
        <rel>next</rel>
        <href>/Fleet/1</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93720</PIN>
        </EquipmentHeader>
        <AverageLoadFactorLast24 datetime="2018-09-04T00:00:00Z">
            <Percent>65.25</Percent>
        </AverageLoadFactorLast24>
        <CumulativeActiveRegenerationHours datetime="2018-09-04T12:34:52Z">
            <Hour>5.30</Hour>
        </CumulativeActiveRegenerationHours>
        <CumulativeIdleHours datetime="2018-09-04T12:34:50Z">
            <Hour>3.31</Hour>
        </CumulativeIdleHours>
        <CumulativeIdleNonOperatingHours datetime="2018-09-04T11:34:33Z">
            <Hour>22.02</Hour>
        </CumulativeIdleNonOperatingHours>
        <CumulativeLoadCount datetime="2018-09-04T01:34:33Z">
            <Count>31</Count>
        </CumulativeLoadCount>
        <CumulativeOperatingHours datetime="2018-09-04T10:31:51Z">
            <Hour>13.53</Hour>
        </CumulativeOperatingHours>
        <CumulativePowerTakeOffHours datetime="2018-09-04T12:34:52Z">
            <Hour>100.04</Hour>
        </CumulativePowerTakeOffHours>
        <CumulativePayloadTotals datetime="2018-09-04T12:35:07Z">
            <PayloadUnits>kilogram</PayloadUnits>
            <Payload>4780.5</Payload>
        </CumulativePayloadTotals>
        <DEFRemaining datetime="2018-09-04T02:03:23Z">
            <Percent>13.00</Percent>
        </DEFRemaining>
        <Distance datetime="2018-09-04T06:14:44Z">
            <OdometerUnits>kilometre</OdometerUnits>
            <Odometer>12.1</Odometer>
        </Distance>
        <EngineStatus datetime="2018-09-04T10:19:11Z">
            <EngineNumber>abc123</EngineNumber>
            <Running>true</Running>
        </EngineStatus>
        <FuelUsed datetime="2018-09-04T09:38:07Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>1</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93721</PIN>
        </EquipmentHeader>
        <AverageLoadFactorLast24 datetime="2018-09-04T00:00:00Z">
            <Percent>55.02</Percent>
        </AverageLoadFactorLast24>
        <CumulativeActiveRegenerationHours datetime="2018-09-04T12:34:52Z">
            <Hour>5.30</Hour>
        </CumulativeActiveRegenerationHours>
        <CumulativeIdleHours datetime="2018-09-04T12:34:50Z">
            <Hour>3.31</Hour>
        </CumulativeIdleHours>
        <CumulativeIdleNonOperatingHours datetime="2018-09-04T11:34:33Z">
            <Hour>22.02</Hour>
        </CumulativeIdleNonOperatingHours>
        <CumulativeLoadCount datetime="2018-09-04T01:34:33Z">
            <Count>31</Count>
        </CumulativeLoadCount>
        <CumulativeOperatingHours datetime="2018-09-04T10:31:51Z">
            <Hour>13.53</Hour>
        </CumulativeOperatingHours>
        <CumulativePowerTakeOffHours datetime="2018-09-04T12:34:52Z">
            <Hour>100.04</Hour>
        </CumulativePowerTakeOffHours>
        <CumulativePayloadTotals datetime="2018-09-04T12:35:07Z">
            <PayloadUnits>kilogram</PayloadUnits>
            <Payload>6710.8</Payload>
        </CumulativePayloadTotals>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93722</PIN>
        </EquipmentHeader>
        <DEFRemaining datetime="2018-09-04T02:03:23Z">
            <Percent>13.00</Percent>
        </DEFRemaining>
        <Distance datetime="2018-09-04T06:14:44Z">
            <OdometerUnits>kilometre</OdometerUnits>
            <Odometer>12.1</Odometer>
        </Distance>
        <EngineStatus datetime="2018-09-04T10:19:11Z">
            <EngineNumber>abc123</EngineNumber>
            <Running>true</Running>
        </EngineStatus>
        <FuelUsed datetime="2018-09-04T09:38:07Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>1</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
</Fleet>

Get a specific Equipment by PIN or VIN including latest metrics

Get a specific Equipment by its PIN or VIN, including latest reported values of its metrics.

Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<Fleet xmlns="http://standards.iso.org/iso/15143/-3" version="1"
       snapshotTime="2018-09-04T12:34:56Z">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1YVFP80C155M15086</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <PIN>1YVFP80C155M15086</PIN>
        </EquipmentHeader>
        <AverageLoadFactorLast24 datetime="2018-09-04T00:00:00Z">
            <Percent>65.25</Percent>
        </AverageLoadFactorLast24>
        <CumulativeActiveRegenerationHours datetime="2018-09-04T12:34:52Z">
            <Hour>5.31</Hour>
        </CumulativeActiveRegenerationHours>
        <CumulativeIdleHours datetime="2018-09-04T12:34:50Z">
            <Hour>3.32</Hour>
        </CumulativeIdleHours>
        <CumulativeIdleNonOperatingHours datetime="2018-09-04T11:34:33Z">
            <Hour>22.03</Hour>
        </CumulativeIdleNonOperatingHours>
        <CumulativeLoadCount datetime="2018-09-04T01:34:33Z">
            <Count>31</Count>
        </CumulativeLoadCount>
        <CumulativeOperatingHours datetime="2018-09-04T10:31:51Z">
            <Hour>13.54</Hour>
        </CumulativeOperatingHours>
        <CumulativePowerTakeOffHours datetime="2018-09-04T12:34:52Z">
            <Hour>100.05</Hour>
        </CumulativePowerTakeOffHours>
        <CumulativePayloadTotals datetime="2018-09-04T12:35:07Z">
            <PayloadUnits>kilogram</PayloadUnits>
            <Payload>4780.5</Payload>
        </CumulativePayloadTotals>
        <DEFRemaining datetime="2018-09-04T02:03:23Z">
            <Percent>13.00</Percent>
        </DEFRemaining>
        <Distance datetime="2018-09-04T06:14:44Z">
            <OdometerUnits>kilometre</OdometerUnits>
            <Odometer>12.1</Odometer>
        </Distance>
        <EngineStatus datetime="2018-09-04T10:19:11Z">
            <EngineNumber>abc123</EngineNumber>
            <Running>true</Running>
        </EngineStatus>
        <FuelUsed datetime="2018-09-04T09:38:07Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>1</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
</Fleet>

Get Equipment by OEM name, model and serial including latest metrics

Get a specific Equipment by the conjunction of its OEM name, model name and serial number including latest reported values of its metrics.

Authorizations:
oauth2
path Parameters
OEMName
required
string

Original equipment manufacturer name (OEMName).

model
required
string

Model name

serial
required
string

Machine serial number

Responses

Response samples

Content type
application/xml
<Fleet xmlns="http://standards.iso.org/iso/15143/-3" version="1"
       snapshotTime="2018-09-04T12:34:56Z">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/MakeModelSerial/%s/%s/%s</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <OEMName>Any Org Inc.</OEMName>
            <Model>M9000</Model>
            <Serial>SER112233</Serial>
            <PIN>1YVFP80C155M15086</PIN>
        </EquipmentHeader>
        <AverageLoadFactorLast24 datetime="2018-09-04T00:00:00Z">
            <Percent>65.25</Percent>
        </AverageLoadFactorLast24>
        <CumulativeActiveRegenerationHours datetime="2018-09-04T12:34:52Z">
            <Hour>5.31</Hour>
        </CumulativeActiveRegenerationHours>
        <CumulativeIdleHours datetime="2018-09-04T12:34:50Z">
            <Hour>3.32</Hour>
        </CumulativeIdleHours>
        <CumulativeIdleNonOperatingHours datetime="2018-09-04T11:34:33Z">
            <Hour>22.03</Hour>
        </CumulativeIdleNonOperatingHours>
        <CumulativeLoadCount datetime="2018-09-04T01:34:33Z">
            <Count>31</Count>
        </CumulativeLoadCount>
        <CumulativeOperatingHours datetime="2018-09-04T10:31:51Z">
            <Hour>13.54</Hour>
        </CumulativeOperatingHours>
        <CumulativePowerTakeOffHours datetime="2018-09-04T12:34:52Z">
            <Hour>100.05</Hour>
        </CumulativePowerTakeOffHours>
        <CumulativePayloadTotals datetime="2018-09-04T12:35:07Z">
            <PayloadUnits>kilogram</PayloadUnits>
            <Payload>4780.5</Payload>
        </CumulativePayloadTotals>
        <DEFRemaining datetime="2018-09-04T02:03:23Z">
            <Percent>13.00</Percent>
        </DEFRemaining>
        <Distance datetime="2018-09-04T06:14:44Z">
            <OdometerUnits>kilometre</OdometerUnits>
            <Odometer>12.1</Odometer>
        </Distance>
        <EngineStatus datetime="2018-09-04T10:19:11Z">
            <EngineNumber>abc123</EngineNumber>
            <Running>true</Running>
        </EngineStatus>
        <FuelUsed datetime="2018-09-04T09:38:07Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>1</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2018-09-04T03:37:32Z">
            <Percent>87.00</Percent>
        </FuelRemaining>
        <MaximumSpeedLast24 datetime="2018-09-04T12:34:52Z">
            <SpeedUnits>kilometres per hour</SpeedUnits>
            <Speed>41.2</Speed>
        </MaximumSpeedLast24>
    </Equipment>
</Fleet>

Fleet PIN timeseries

Endpoints to retrieve timeseries for a specific metric searching by PIN or VIN.

Links to timeseries of all metrics available for equipment in the given range

Get links to timeseries of all metrics available for the given PIN or VIN in the given time-range. This method makes its best effort only to include links to metrics that contain a datapoint in the requested range. However, due to implementation details, it may sometimes return false-positives (i.e. links that will yield 0 datapoints when queried).

Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<FleetTS xmlns="http://standards.iso.org/iso/15143/-3" version="1">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/2018-09-03T12:34:56Z/2018-09-04T12:34:56Z</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93726</PIN>
        </EquipmentHeader>
        <Links>
            <rel>CumulativeOperatingHours</rel>
            <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeOperatingHours/2018-09-03T12:34:56Z/2018-09-04T12:34:56Z</href>
        </Links>
        <Links>
            <rel>Distance</rel>
            <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Distance/2018-09-03T12:34:56Z/2018-09-04T12:34:56Z</href>
        </Links>
    </Equipment>
</FleetTS>

Latest AverageDailyEngineLoadFactors within last 2 weeks

Metric represents the average daily engine load for this machine.

  • the metric can be calculated by DataPlatform or mapped directly
  • PDC metric key value.common.engine.loadfactor.last.24hr is used for direct mapping takes precedence
  • PDC metric key value.common.engine.loadfactor.current is used for calculated values
    • for snapshots the average engine load in last 24h is returned
    • for timeseries each returned datapoint represents average engine load during a 24h period ending at UTC midnight
  • PDC unit used predefined.unit.PERCENT
  • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
  • absence of the AverageLoadFactorLast24 tag means that no load factor value was available in the time-range
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<AverageLoadFactorLast24 xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/AverageDailyEngineLoadFactors</href>
    </Links>
    <LoadFactor datetime="2018-09-03T00:00:00Z">
        <Percent>60.00</Percent>
    </LoadFactor>
    <LoadFactor datetime="2018-09-04T00:00:00Z">
        <Percent>35.25</Percent>
    </LoadFactor>
</AverageLoadFactorLast24>

AverageDailyEngineLoadFactors in time-range

Metric represents the average daily engine load for this machine.

  • the metric can be calculated by DataPlatform or mapped directly
  • PDC metric key value.common.engine.loadfactor.last.24hr is used for direct mapping takes precedence
  • PDC metric key value.common.engine.loadfactor.current is used for calculated values
    • for snapshots the average engine load in last 24h is returned
    • for timeseries each returned datapoint represents average engine load during a 24h period ending at UTC midnight
  • PDC unit used predefined.unit.PERCENT
  • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
  • absence of the AverageLoadFactorLast24 tag means that no load factor value was available in the time-range
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<AverageLoadFactorLast24 xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/AverageDailyEngineLoadFactors/2018-09-03T01:02:03Z/2018-09-04T07:04:05Z
        </href>
    </Links>
    <LoadFactor datetime="2018-09-03T00:00:00Z">
        <Percent>60.00</Percent>
    </LoadFactor>
    <LoadFactor datetime="2018-09-04T00:00:00Z">
        <Percent>35.25</Percent>
    </LoadFactor>
</AverageLoadFactorLast24>

Latest Distance within last 2 weeks

Distance metric is cumulative distance travelled

  • PDC metric key used value.common.machine.distance.total
  • PDC unit expected predefined.unit.length.KILOMETER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<DistanceMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Distance</href>
    </Links>
    <Distance datetime="2018-09-03T00:00:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>15.2</Odometer>
    </Distance>
    <Distance datetime="2018-09-07T00:00:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>12.2</Odometer>
    </Distance>
</DistanceMessages>

Distance in time-range

Distance metric is cumulative distance travelled

  • PDC metric key used value.common.machine.distance.total
  • PDC unit expected predefined.unit.length.KILOMETER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<DistanceMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Distance/2018-09-03T01:02:03Z/2018-09-03T01:04:05Z</href>
    </Links>
    <Distance datetime="2018-09-03T01:02:30Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>15.2</Odometer>
    </Distance>
    <Distance datetime="2018-09-03T01:03:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>15.8</Odometer>
    </Distance>
    <Distance datetime="2018-09-03T01:03:30Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>16.6</Odometer>
    </Distance>
    <Distance datetime="2018-09-03T01:04:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>16.7</Odometer>
    </Distance>
</DistanceMessages>

Latest CumulativeFuelUsed within last 2 weeks

Metric represents the cumulative amount of fuel used by the machine since its manufacture.

  • PDC metric key used value.common.engine.fuel.used.total
  • PDC unit expected predefined.unit.volume.LITER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeFuelUsed</href>
    </Links>
    <FuelUsed datetime="2018-09-03T00:00:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>12</FuelConsumed>
    </FuelUsed>
    <FuelUsed datetime="2018-09-07T00:00:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>39</FuelConsumed>
    </FuelUsed>
</FuelUsedMessages>

CumulativeFuelUsed in time-range

Metric represents the cumulative amount of fuel used by the machine since its manufacture.

  • PDC metric key used value.common.engine.fuel.used.total
  • PDC unit expected predefined.unit.volume.LITER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeFuelUsed/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <FuelUsed datetime="2018-09-03T01:06:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>12</FuelConsumed>
    </FuelUsed>
    <FuelUsed datetime="2018-09-03T03:05:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>39</FuelConsumed>
    </FuelUsed>
</FuelUsedMessages>

Latest CumulativeIdleHours within last 2 weeks

The current lifetime total cumulative idle operating hours of the machine. The definition of idle state is unique to each manufacturer.

  • PDC metric key used value.common.machine.hours.oem.specific.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativeIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeIdleHours</href>
    </Links>
    <CumulativeIdleHours datetime="2018-09-03T00:00:00Z">
        <Hour>5.00</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2018-09-07T00:00:00Z">
        <Hour>2.28</Hour>
    </CumulativeIdleHours>
</CumulativeIdleHoursMessages>

CumulativeIdleHours in time-range

The current lifetime total cumulative idle operating hours of the machine. The definition of idle state is unique to each manufacturer.

  • PDC metric key used value.common.machine.hours.oem.specific.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeIdleHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeIdleHours datetime="2018-09-03T01:06:00Z">
        <Hour>5.00</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2018-09-03T03:05:00Z">
        <Hour>2.28</Hour>
    </CumulativeIdleHours>
</CumulativeIdleHoursMessages>

Latest CumulativeLoadCount within last 2 weeks

Lifetime total cumulative number of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.count.total
  • PDC unit expected predefined.unit.NUMBER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativeLoadCountMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeLoadCount</href>
    </Links>
    <CumulativeLoadCount datetime="2018-09-03T00:00:00Z">
        <Count>12</Count>
    </CumulativeLoadCount>
    <CumulativeLoadCount datetime="2018-09-07T00:00:00Z">
        <Count>71</Count>
    </CumulativeLoadCount>
</CumulativeLoadCountMessages>

CumulativeLoadCount in time-range

Lifetime total cumulative number of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.count.total
  • PDC unit expected predefined.unit.NUMBER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeLoadCountMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeLoadCount/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeLoadCount datetime="2018-09-03T01:06:00Z">
        <Count>53</Count>
    </CumulativeLoadCount>
    <CumulativeLoadCount datetime="2018-09-03T03:05:00Z">
        <Count>17</Count>
    </CumulativeLoadCount>
</CumulativeLoadCountMessages>

Latest CumulativeNonProductiveIdleHours within last 2 weeks

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.

  • PDC metric key used value.common.machine.hours.idle.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativeNonproductiveIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeNonProductiveIdleHours</href>
    </Links>
    <CumulativeNonproductiveIdleHours datetime="2018-09-03T00:00:00Z">
        <Hour>6.00</Hour>
    </CumulativeNonproductiveIdleHours>
    <CumulativeNonproductiveIdleHours datetime="2018-09-07T00:00:00Z">
        <Hour>1.23</Hour>
    </CumulativeNonproductiveIdleHours>
</CumulativeNonproductiveIdleHoursMessages>

CumulativeNonProductiveIdleHours in time-range

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.

  • PDC metric key used value.common.machine.hours.idle.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeNonproductiveIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeNonProductiveIdleHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeNonproductiveIdleHours datetime="2018-09-03T01:06:00Z">
        <Hour>6.00</Hour>
    </CumulativeNonproductiveIdleHours>
    <CumulativeNonproductiveIdleHours datetime="2018-09-03T03:05:00Z">
        <Hour>1.23</Hour>
    </CumulativeNonproductiveIdleHours>
</CumulativeNonproductiveIdleHoursMessages>

Latest CumulativeOperatingHours within last 2 weeks

The current lifetime total cumulative operating hours of the machine.

  • PDC metric key used value.common.machine.hours.operation.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativeOperatingHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeOperatingHours</href>
    </Links>
    <CumulativeOperatingHours datetime="2018-09-03T00:00:00Z">
        <Hour>41.23</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2018-09-07T00:00:00Z">
        <Hour>43.23</Hour>
    </CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>

CumulativeOperatingHours in time-range

The current lifetime total cumulative operating hours of the machine.

  • PDC metric key used value.common.machine.hours.operation.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeOperatingHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeOperatingHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeOperatingHours datetime="2018-09-03T01:06:00Z">
        <Hour>41.23</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2018-09-03T03:05:00Z">
        <Hour>43.23</Hour>
    </CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>

Latest CumulativeActiveRegenerationHours within last 2 weeks

The current lifetime total non-productive regeneration hours of the machine. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process.

  • PDC metric key used value.common.engine.hours.regeneration.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativeActiveRegenerationHourMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeActiveRegenerationHours</href>
    </Links>
    <CumulativeActiveRegenerationHours datetime="2018-09-03T00:00:00Z">
        <Hour>4.00</Hour>
    </CumulativeActiveRegenerationHours>
    <CumulativeActiveRegenerationHours datetime="2018-09-07T00:00:00Z">
        <Hour>1.46</Hour>
    </CumulativeActiveRegenerationHours>
</CumulativeActiveRegenerationHourMessages>

CumulativeActiveRegenerationHours in time-range

The current lifetime total non-productive regeneration hours of the machine. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process.

  • PDC metric key used value.common.engine.hours.regeneration.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeActiveRegenerationHourMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeActiveRegenerationHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeActiveRegenerationHours datetime="2018-09-03T01:06:00Z">
        <Hour>4.00</Hour>
    </CumulativeActiveRegenerationHours>
    <CumulativeActiveRegenerationHours datetime="2018-09-03T03:05:00Z">
        <Hour>1.46</Hour>
    </CumulativeActiveRegenerationHours>
</CumulativeActiveRegenerationHourMessages>

Latest CumulativePowerTakeOffHours within last 2 weeks

Current lifetime total power take-off hours of the machine.

  • PDC metric key used value.common.machine.hours.pto.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativePowerTakeOffHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePowerTakeOffHours</href>
    </Links>
    <CumulativePowerTakeOffHours datetime="2018-09-03T00:00:00Z">
        <Hour>3.00</Hour>
    </CumulativePowerTakeOffHours>
    <CumulativePowerTakeOffHours datetime="2018-09-07T00:00:00Z">
        <Hour>2.22</Hour>
    </CumulativePowerTakeOffHours>
</CumulativePowerTakeOffHoursMessages>

CumulativePowerTakeOffHours in time-range

Current lifetime total power take-off hours of the machine.

  • PDC metric key used value.common.machine.hours.pto.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativePowerTakeOffHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePowerTakeOffHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativePowerTakeOffHours datetime="2018-09-03T01:06:00Z">
        <Hour>2.22</Hour>
    </CumulativePowerTakeOffHours>
    <CumulativePowerTakeOffHours datetime="2018-09-03T03:05:00Z">
        <Hour>3.00</Hour>
    </CumulativePowerTakeOffHours>
</CumulativePowerTakeOffHoursMessages>

Latest CumulativePayloadTotals within last 2 weeks

Lifetime total cumulative mass of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.total
  • PDC unit expected predefined.unit.mass.KILOGRAM
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CumulativePayloadTotalMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePayloadTotals</href>
    </Links>
    <CumulativePayloadTotals datetime="2018-09-03T00:00:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1287.1</Payload>
    </CumulativePayloadTotals>
    <CumulativePayloadTotals datetime="2018-09-07T00:00:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1380.5</Payload>
    </CumulativePayloadTotals>
</CumulativePayloadTotalMessages>

CumulativePayloadTotals in time-range

Lifetime total cumulative mass of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.total
  • PDC unit expected predefined.unit.mass.KILOGRAM
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativePayloadTotalMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePayloadTotals/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativePayloadTotals datetime="2018-09-03T01:06:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1287.1</Payload>
    </CumulativePayloadTotals>
    <CumulativePayloadTotals datetime="2018-09-03T03:05:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1380.5</Payload>
    </CumulativePayloadTotals>
</CumulativePayloadTotalMessages>

Latest DEFRemaining within last 2 weeks

The percentage of DEF remaining in the DEF tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.def.level
  • PDC unit expected predefined.unit.PERCENT

The response includes the following fields:

Note that the value for DEF tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

Field Type Description
DEFTankCapacity number This field indicates the capacity of the DEF tank. If DefTankCapacity is not available, it will send 0.
DEFTankCapacityUnits string If the DEF tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Def tank capacity shall be expressed in litre.

For machines without DEF system, refer to the table listed below:

Machines without DEF system

The following table shows how the DEF component is handled to be compliant with the MiC standard for machines that do not send any value for the DEFremaining parameter, or electric machines without a tank, or non-diesel machines.

Level is logged Capacity is set Capacity Value Values to expose Description
No No N/A None Nothing exposed.
No Yes !=0 None There might be a configuration mistake either in signal logging or capacity attribute.
No Yes =0 Level = 0 and Capacity = 0 Reflects that the DEF component is not present in this machine.
Yes No N/A Level Only the remaining level is logged.
Yes Yes Any Level and Capacity The remaining level and capacity are logged.
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<DEFRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/DEFRemaining</href>
    </Links>
      <DEFRemaining datetime=""2025-02-04T00:00:00Z">
        <Percent>78.16</Percent>
        <DEFTankCapacityUnits>litre</DEFTankCapacityUnits>
        <DEFTankCapacity>88</DEFTankCapacity>
      </FuelRemaining>
</DEFRemainingMessages>

DEFRemaining in time-range

The percentage of DEF remaining in the DEF tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.def.level
  • PDC unit expected predefined.unit.PERCENT

The response includes the following fields:

Note that the value for DEF tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

Field Type Description
DEFTankCapacity number This field indicates the capacity of the DEF tank. If DefTankCapacity is not available, it will send 0.
DEFTankCapacityUnits string If the DEF tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Def tank capacity shall be expressed in litre.

For machines without DEF system, refer to the table listed below:

Machines without DEF system

The following table shows how the DEF component is handled to be compliant with the MiC standard for machines that do not send any value for the DEFremaining parameter, or electric machines without a tank, or non-diesel machines.

Level is logged Capacity is set Capacity Value Values to expose Description
No No N/A None Nothing exposed.
No Yes !=0 None There might be a configuration mistake either in signal logging or capacity attribute.
No Yes =0 Level = 0 and Capacity = 0 Reflects that the DEF component is not present in this machine.
Yes No N/A Level Only the remaining level is logged.
Yes Yes Any Level and Capacity The remaining level and capacity are logged.
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<DEFRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/DEFRemaining/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <DEFRemaining datetime="2018-09-03T01:06:00Z">
        <Percent>94.50</Percent>
    </DEFRemaining>
    <DEFRemaining datetime="2018-09-03T03:05:00Z">
        <Percent>26.61</Percent>
    </DEFRemaining>
</DEFRemainingMessages>

Latest EngineCondition within last 2 weeks

Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.

  • The EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:

    • both underlying metrics have to be configured and present
    • the Running value drives the datetime in each datapoint
    • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range

  • for EngineNumber

    • PDC metric key used value.common.engine.identification.serialnumber
    • PDC unit expected predefined.unit.TEXT

  • for EngineRunning

    • PDC metric key used value.common.engine.state
    • PDC unit expected predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<EngineStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/EngineCondition</href>
    </Links>
    <EngineStatus datetime="2018-09-03T00:00:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>true</Running>
    </EngineStatus>
    <EngineStatus datetime="2018-09-07T00:00:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>false</Running>
    </EngineStatus>
</EngineStatusMessages>

EngineCondition in time-range

Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.

  • The EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:

    • both underlying metrics have to be configured and present
    • the Running value drives the datetime in each datapoint
    • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range

  • for EngineNumber

    • PDC metric key used value.common.engine.identification.serialnumber
    • PDC unit expected predefined.unit.TEXT

  • for EngineRunning

    • PDC metric key used value.common.engine.state
    • PDC unit expected predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<EngineStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/EngineCondition/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <EngineStatus datetime="2018-09-03T01:06:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>true</Running>
    </EngineStatus>
    <EngineStatus datetime="2018-09-03T03:05:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>false</Running>
    </EngineStatus>
</EngineStatusMessages>

Latest Faults within last 2 weeks

Also known as DiagnosticTroubleCodes, FaultCodes. Response contains all active faults in the time range (even if the start and/or end time of the fault is outside the range).

For example, machine has following Faults:

  1. start date: 01.01.2020, end date: 02.01.2020
  2. start date: 01.01.2020, end date: 10.01.2020
  3. start date: 02.01.2020, end date: 12.01.2020
  4. start date: 03.01.2020, end date: 05.01.2020
  5. start date: 11.01.2020, end date: 12.01.2020

Request with range from 03.01.2020 to 10.01.2020 would return faults 2, 3 and 4, because they were active during the time range.

AirTemperature and TemperatureUnit appear for a DTC if all true:

  • machine PDC has value.common.cu.sensors.temperature signal and requester is permissioned to see it;
  • machine has data point for value.common.cu.sensors.temperature which is within an 1 hour before the DTC start time;
  • DTC start time is within requested timerange or not older than 30 days before requested timerange.

CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}

Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Faults</href>
    </Links>
    <FaultCode datetime="2018-09-03T00:00:00Z">
        <CodeIdentifier>676</CodeIdentifier>
        <CodeDescription>SPN: Engine Glow Plug Relay; FMI: Current Above Normal Or Grounded Circuit; Source: Brakes - System Controller; End: 2018-09-03T00:00:00Z</CodeDescription>
        <CodeSeverity>6</CodeSeverity>
        <CodeSource>11</CodeSource>
    </FaultCode>
    <FaultCode datetime="2018-09-07T00:00:00Z">
        <CodeIdentifier>677</CodeIdentifier>
        <CodeDescription>SPN: Engine Starter Motor Relay; FMI: Current Above Normal Or Grounded Circuit; Source: Brakes - System Controller; End: 2018-09-07T00:00:00Z</CodeDescription>
        <CodeSeverity>6</CodeSeverity>
        <AirTemperature>-10</AirTemperature>
        <TemperatureUnit>Celsius</TemperatureUnit>
        <CodeSource>11</CodeSource>
    </FaultCode>
</DiagnosticTroubleCode>

Faults in time-range

Also known as DiagnosticTroubleCodes, FaultCodes. Response contains all active faults in the time range (even if the start and/or end time of the fault is outside the range).

For example, machine has following Faults:

  1. start date: 01.01.2020, end date: 02.01.2020
  2. start date: 01.01.2020, end date: 10.01.2020
  3. start date: 02.01.2020, end date: 12.01.2020
  4. start date: 03.01.2020, end date: 05.01.2020
  5. start date: 11.01.2020, end date: 12.01.2020

Request with range from 03.01.2020 to 10.01.2020 would return faults 2, 3 and 4, because they were active during the time range.

AirTemperature and TemperatureUnit appear for a DTC if all true:

  • machine PDC has value.common.cu.sensors.temperature signal and requester is permissioned to see it;
  • machine has data point for value.common.cu.sensors.temperature which is within an 1 hour before the DTC start time;
  • DTC start time is within requested timerange or not older than 30 days before requested timerange.

CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}

Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Faults/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <FaultCode datetime="2018-09-03T01:06:00Z">
        <CodeIdentifier>676</CodeIdentifier>
        <CodeDescription>SPN: Engine Glow Plug Relay; FMI: Current Above Normal Or Grounded Circuit; Source: Brakes - System Controller; End: 2018-09-03T01:06:00Z</CodeDescription>
        <CodeSeverity>6</CodeSeverity>
        <AirTemperature>-10</AirTemperature>
        <TemperatureUnit>Celsius</TemperatureUnit>
        <CodeSource>11</CodeSource>
    </FaultCode>
</DiagnosticTroubleCode>

Latest FuelRemainingRatio within last 2 weeks

The percentage of fuel remaining in the fuel tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.fuel.level
  • PDC unit expected predefined.unit.PERCENT

Note that the value for fuel tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

The response includes the following fields:

Field Type Description
FuelTankCapacity int64, 0 to 4294967295 This field indicates the capacity of the fuel tank. The value is expressed as an unsigned integer, which includes all values from 0 to 4294967295.
FuelTankCapacityUnits string If the fuel tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Fuel tank capacity shall be expressed in litre.
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<FuelRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/FuelRemainingRatio</href>
    </Links>
      <FuelRemaining datetime="...">
        <Percent>78.16</Percent>
        <FuelTankCapacityUnits>litre</FuelTankCapacityUnits>
        <FuelTankCapacity>88</FuelTankCapacity>
      </FuelRemaining>
</FuelRemainingMessages>

FuelRemainingRatio in time-range

The percentage of fuel remaining in the fuel tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.fuel.level
  • PDC unit expected predefined.unit.PERCENT

Note that the value for fuel tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

The response includes the following fields:

Field Type Description
FuelTankCapacity int64, 0 to 4294967295 This field indicates the capacity of the fuel tank. The value is expressed as an unsigned integer, which includes all values from 0 to 4294967295.
FuelTankCapacityUnits string If the fuel tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Fuel tank capacity shall be expressed in litre.
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<FuelRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/FuelRemainingRatio/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <FuelRemaining datetime="2018-09-03T01:06:00Z">
        <Percent>14.50</Percent>
    </FuelRemaining>
    <FuelRemaining datetime="2018-09-03T03:05:00Z">
        <Percent>76.61</Percent>
    </FuelRemaining>
</FuelRemainingMessages>

Latest Locations within last 2 weeks

The last known equipment location.

  • Latitude - from Geo dataset
  • Longitude - from Geo dataset
  • Altitude - from Geo dataset
    • unit expected predefined.unit.length.METER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<LocationMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Locations</href>
    </Links>
    <Location datetime="2018-09-03T00:00:00Z">
        <Latitude>13.457124</Latitude>
        <Longitude>42.003629</Longitude>
        <Altitude>0.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
    <Location datetime="2018-09-07T00:00:00Z">
        <Latitude>23.457124</Latitude>
        <Longitude>52.003629</Longitude>
        <Altitude>212.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
    <Location datetime="2018-09-09T00:00:00Z">
        <Latitude>22.457124</Latitude>
        <Longitude>51.003629</Longitude>
        <Altitude>412.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
</LocationMessages>

Locations in time-range

The last known equipment location.

  • Latitude - from Geo dataset
  • Longitude - from Geo dataset
  • Altitude - from Geo dataset
    • unit expected predefined.unit.length.METER
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<LocationMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Locations/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <Location datetime="2018-09-03T01:06:00Z">
        <Latitude>23.457124</Latitude>
        <Longitude>52.003629</Longitude>
        <Altitude>212.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
    <Location datetime="2018-09-03T03:05:00Z">
        <Latitude>22.457124</Latitude>
        <Longitude>51.003629</Longitude>
        <Altitude>412.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
</LocationMessages>

Latest PeakDailySpeed within last 2 weeks

Peak daily speed is the highest achieved travel speed for this machine. Each returned datapoint represents maximum speed during a 24-hour period ending at UTC midnight. The absence of the PeakDailySpeed tag means that no speed value was available in the time-range.

  • PDC metric key used value.common.machine.speed
  • PDC unit expected predefined.unit.speed.KILOMETERS_PER_HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<PeakDailySpeedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/PeakDailySpeed</href>
    </Links>
    <Speed datetime="2018-09-03T00:00:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>212.0</Speed>
    </Speed>
    <Speed datetime="2018-09-07T00:00:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>141.3</Speed>
    </Speed>
</PeakDailySpeedMessages>

PeakDailySpeed in time-range

Peak daily speed is the highest achieved travel speed for this machine. Each returned datapoint represents maximum speed during a 24-hour period ending at UTC midnight. The absence of the PeakDailySpeed tag means that no speed value was available in the time-range.

  • PDC metric key used value.common.machine.speed
  • PDC unit expected predefined.unit.speed.KILOMETERS_PER_HOUR
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<PeakDailySpeedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/PeakDailySpeed/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <Speed datetime="2018-09-03T01:06:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>212.2</Speed>
    </Speed>
    <Speed datetime="2018-09-03T03:05:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>141.0</Speed>
    </Speed>
</PeakDailySpeedMessages>

Latest CautionCodes within last 2 weeks

CautionCodes is a time-series only metric.

  • CautionMessages contains a list of CautionDescription items, populated by signals with PDC valueDefinition category StateSignal and attribute machineError=true.
  • Each CautionDescription represents the number of a code that occurred at a specific date and time.
  • Identifier and Description are taken from aempCautionCode section in the PDC. If it is absent then the state value and description are used.
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<CautionMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CautionCodes</href>
    </Links>
    <CautionDescription datetime="2018-09-03T00:00:00Z">
        <Identifier>ISO 7000-1167</Identifier>
        <Description>Transmission oil-pressure</Description>
    </CautionDescription>
    <CautionDescription datetime="2018-09-08T00:00:00Z">
        <Identifier>ISO 7000-1171</Identifier>
        <Description>Hydraulic clutch</Description>
    </CautionDescription>
</CautionMessages>

CautionCodes in time-range

CautionCodes is a time-series only metric.

  • CautionMessages contains a list of CautionDescription items, populated by signals with PDC valueDefinition category StateSignal and attribute machineError=true.
  • Each CautionDescription represents the number of a code that occurred at a specific date and time.
  • Identifier and Description are taken from aempCautionCode section in the PDC. If it is absent then the state value and description are used.
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CautionMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CautionCodes/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CautionDescription datetime="2018-09-03T00:00:00Z">
        <Identifier>ISO 7000 - 1167</Identifier>
        <Description>Transmission oil-pressure</Description>
    </CautionDescription>
    <CautionDescription datetime="2018-09-08T00:00:00Z">
        <Identifier>ISO 7000 - 1167</Identifier>
        <Description>Hydraulic clutch</Description>
    </CautionDescription>
</CautionMessages>

Latest SwitchStatus within last 2 weeks

Metric provides digital inputs state changes. The metric is time-series only.

  • SwitchStatusMessages contains a list of SwitchStatus items
  • Each SwitchStatus represents a change of status IsOn of a specific switch SwitchNumber that occurred at a specific date and time.
  • PDC metric key used value.common.machine.inputs.digital.[number] where number defines a switch number.
  • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

Responses

Response samples

Content type
application/xml
<SwitchStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/SwitchStatus</href>
    </Links>
    <SwitchStatus datetime="2018-09-03T04:02:03Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T07:14:00Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>false</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T05:20:03Z">
        <SwitchNumber>42</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
</SwitchStatusMessages>

SwitchStatus in time-range

Metric provides digital inputs state changes. The metric is time-series only.

  • SwitchStatusMessages contains a list of SwitchStatus items
  • Each SwitchStatus represents a change of status IsOn of a specific switch SwitchNumber that occurred at a specific date and time.
  • PDC metric key used value.common.machine.inputs.digital.[number] where number defines a switch number.
  • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
pinOrVin
required
string

A PIN or VIN to look up

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<SwitchStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/SwitchStatus/2018-09-03T01:02:03Z/2018-09-04T07:04:05Z</href>
    </Links>
    <SwitchStatus datetime="2018-09-03T04:02:03Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T07:14:00Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>false</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T05:20:03Z">
        <SwitchNumber>42</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
</SwitchStatusMessages>

Fleet MakeModelSerial timeseries

Endpoints to retrieve timeseries for a specific metric by OEMName-Model-Serial.

Links to timeseries of all metrics available for equipment in the given range (MMS)

Get links to timeseries of all metrics available for the given make, model and serial in the given time-range. This method makes its best effort only to include links to metrics that contain a datapoint in the requested range. However, due to implementation details, it may sometimes return false-positives (i.e. links that will yield 0 datapoints when queried).

Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

Start of requested time-range (ISO-8601 UTC). Max 14 days.

endDateTime
required
string

End of requested time-range (ISO-8601 UTC). Max 14 days.

Responses

Response samples

Content type
application/xml
<FleetTS xmlns="http://standards.iso.org/iso/15143/-3" version="1">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/2018-09-03T12:34:56Z/2018-09-04T12:34:56Z</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <PIN>1FTZR11U33PA93726</PIN>
        </EquipmentHeader>
        <Links>
            <rel>CumulativeOperatingHours</rel>
            <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeOperatingHours/2018-09-03T12:34:56Z/2018-09-04T12:34:56Z</href>
        </Links>
        <Links>
            <rel>Distance</rel>
            <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Distance/2018-09-03T12:34:56Z/2018-09-04T12:34:56Z</href>
        </Links>
    </Equipment>
</FleetTS>

Latest AverageDailyEngineLoadFactors within last 2 weeks (MMS)

Metric represents the average daily engine load for this machine.

  • the metric can be calculated by DataPlatform or mapped directly
  • PDC metric key value.common.engine.loadfactor.last.24hr is used for direct mapping takes precedence
  • PDC metric key value.common.engine.loadfactor.current is used for calculated values
    • for snapshots the average engine load in last 24h is returned
    • for timeseries each returned datapoint represents average engine load during a 24h period ending at UTC midnight
  • PDC unit used predefined.unit.PERCENT
  • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
  • absence of the AverageLoadFactorLast24 tag means that no load factor value was available in the time-range
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<AverageLoadFactorLast24 xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/AverageDailyEngineLoadFactors</href>
    </Links>
    <LoadFactor datetime="2018-09-03T00:00:00Z">
        <Percent>60.00</Percent>
    </LoadFactor>
    <LoadFactor datetime="2018-09-04T00:00:00Z">
        <Percent>35.25</Percent>
    </LoadFactor>
</AverageLoadFactorLast24>

AverageDailyEngineLoadFactors in time-range (MMS)

Metric represents the average daily engine load for this machine.

  • the metric can be calculated by DataPlatform or mapped directly
  • PDC metric key value.common.engine.loadfactor.last.24hr is used for direct mapping takes precedence
  • PDC metric key value.common.engine.loadfactor.current is used for calculated values
    • for snapshots the average engine load in last 24h is returned
    • for timeseries each returned datapoint represents average engine load during a 24h period ending at UTC midnight
  • PDC unit used predefined.unit.PERCENT
  • only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)
  • absence of the AverageLoadFactorLast24 tag means that no load factor value was available in the time-range
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<AverageLoadFactorLast24 xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/AverageDailyEngineLoadFactors/2018-09-03T01:02:03Z/2018-09-04T07:04:05Z
        </href>
    </Links>
    <LoadFactor datetime="2018-09-03T00:00:00Z">
        <Percent>60.00</Percent>
    </LoadFactor>
    <LoadFactor datetime="2018-09-04T00:00:00Z">
        <Percent>35.25</Percent>
    </LoadFactor>
</AverageLoadFactorLast24>

Latest Distance within last 2 weeks (MMS)

Distance metric is cumulative distance travelled

  • PDC metric key used value.common.machine.distance.total
  • PDC unit expected predefined.unit.length.KILOMETER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<DistanceMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Distance</href>
    </Links>
    <Distance datetime="2018-09-03T00:00:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>15.2</Odometer>
    </Distance>
    <Distance datetime="2018-09-07T00:00:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>12.2</Odometer>
    </Distance>
</DistanceMessages>

Distance in time-range (MMS)

Distance metric is cumulative distance travelled

  • PDC metric key used value.common.machine.distance.total
  • PDC unit expected predefined.unit.length.KILOMETER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<DistanceMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Distance/2018-09-03T01:02:03Z/2018-09-03T01:04:05Z</href>
    </Links>
    <Distance datetime="2018-09-03T01:02:30Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>15.2</Odometer>
    </Distance>
    <Distance datetime="2018-09-03T01:03:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>15.8</Odometer>
    </Distance>
    <Distance datetime="2018-09-03T01:03:30Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>16.6</Odometer>
    </Distance>
    <Distance datetime="2018-09-03T01:04:00Z">
        <OdometerUnits>kilometre</OdometerUnits>
        <Odometer>16.7</Odometer>
    </Distance>
</DistanceMessages>

Latest CumulativeFuelUsed within last 2 weeks (MMS)

Metric represents the cumulative amount of fuel used by the machine since its manufacture.

  • PDC metric key used value.common.engine.fuel.used.total
  • PDC unit expected predefined.unit.volume.LITER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeFuelUsed</href>
    </Links>
    <FuelUsed datetime="2018-09-03T00:00:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>12</FuelConsumed>
    </FuelUsed>
    <FuelUsed datetime="2018-09-07T00:00:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>39</FuelConsumed>
    </FuelUsed>
</FuelUsedMessages>

CumulativeFuelUsed in time-range (MMS)

Metric represents the cumulative amount of fuel used by the machine since its manufacture.

  • PDC metric key used value.common.engine.fuel.used.total
  • PDC unit expected predefined.unit.volume.LITER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeFuelUsed/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <FuelUsed datetime="2018-09-03T01:06:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>12</FuelConsumed>
    </FuelUsed>
    <FuelUsed datetime="2018-09-03T03:05:00Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>39</FuelConsumed>
    </FuelUsed>
</FuelUsedMessages>

Latest CumulativeIdleHours within last 2 weeks (MMS)

The current lifetime total cumulative idle operating hours of the machine. The definition of idle state is unique to each manufacturer.

  • PDC metric key used value.common.machine.hours.oem.specific.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativeIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeIdleHours</href>
    </Links>
    <CumulativeIdleHours datetime="2018-09-03T00:00:00Z">
        <Hour>5.00</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2018-09-07T00:00:00Z">
        <Hour>2.28</Hour>
    </CumulativeIdleHours>
</CumulativeIdleHoursMessages>

CumulativeIdleHours in time-range (MMS)

The current lifetime total cumulative idle operating hours of the machine. The definition of idle state is unique to each manufacturer.

  • PDC metric key used value.common.machine.hours.oem.specific.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeIdleHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeIdleHours datetime="2018-09-03T01:06:00Z">
        <Hour>5.00</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2018-09-03T03:05:00Z">
        <Hour>2.28</Hour>
    </CumulativeIdleHours>
</CumulativeIdleHoursMessages>

Latest CumulativeLoadCount within last 2 weeks (MMS)

Lifetime total cumulative number of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.count.total
  • PDC unit expected predefined.unit.NUMBER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativeLoadCountMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeLoadCount</href>
    </Links>
    <CumulativeLoadCount datetime="2018-09-03T00:00:00Z">
        <Count>12</Count>
    </CumulativeLoadCount>
    <CumulativeLoadCount datetime="2018-09-07T00:00:00Z">
        <Count>71</Count>
    </CumulativeLoadCount>
</CumulativeLoadCountMessages>

CumulativeLoadCount in time-range (MMS)

Lifetime total cumulative number of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.count.total
  • PDC unit expected predefined.unit.NUMBER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeLoadCountMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeLoadCount/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeLoadCount datetime="2018-09-03T01:06:00Z">
        <Count>53</Count>
    </CumulativeLoadCount>
    <CumulativeLoadCount datetime="2018-09-03T03:05:00Z">
        <Count>17</Count>
    </CumulativeLoadCount>
</CumulativeLoadCountMessages>

Latest CumulativeNonProductiveIdleHours within last 2 weeks (MMS)

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.

  • PDC metric key used value.common.machine.hours.idle.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativeNonproductiveIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeNonProductiveIdleHours</href>
    </Links>
    <CumulativeNonproductiveIdleHours datetime="2018-09-03T00:00:00Z">
        <Hour>6.00</Hour>
    </CumulativeNonproductiveIdleHours>
    <CumulativeNonproductiveIdleHours datetime="2018-09-07T00:00:00Z">
        <Hour>1.23</Hour>
    </CumulativeNonproductiveIdleHours>
</CumulativeNonproductiveIdleHoursMessages>

CumulativeNonProductiveIdleHours in time-range (MMS)

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.

  • PDC metric key used value.common.machine.hours.idle.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeNonproductiveIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeNonProductiveIdleHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeNonproductiveIdleHours datetime="2018-09-03T01:06:00Z">
        <Hour>6.00</Hour>
    </CumulativeNonproductiveIdleHours>
    <CumulativeNonproductiveIdleHours datetime="2018-09-03T03:05:00Z">
        <Hour>1.23</Hour>
    </CumulativeNonproductiveIdleHours>
</CumulativeNonproductiveIdleHoursMessages>

Latest CumulativeOperatingHours within last 2 weeks (MMS)

The current lifetime total cumulative operating hours of the machine.

  • PDC metric key used value.common.machine.hours.operation.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativeOperatingHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeOperatingHours</href>
    </Links>
    <CumulativeOperatingHours datetime="2018-09-03T00:00:00Z">
        <Hour>41.23</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2018-09-07T00:00:00Z">
        <Hour>43.23</Hour>
    </CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>

CumulativeOperatingHours in time-range (MMS)

The current lifetime total cumulative operating hours of the machine.

  • PDC metric key used value.common.machine.hours.operation.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeOperatingHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeOperatingHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeOperatingHours datetime="2018-09-03T01:06:00Z">
        <Hour>41.23</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2018-09-03T03:05:00Z">
        <Hour>43.23</Hour>
    </CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>

Latest CumulativeActiveRegenerationHours within last 2 weeks (MMS)

The current lifetime total non-productive regeneration hours of the machine. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process.

  • PDC metric key used value.common.engine.hours.regeneration.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativeActiveRegenerationHourMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeActiveRegenerationHours</href>
    </Links>
    <CumulativeActiveRegenerationHours datetime="2018-09-03T00:00:00Z">
        <Hour>4.00</Hour>
    </CumulativeActiveRegenerationHours>
    <CumulativeActiveRegenerationHours datetime="2018-09-07T00:00:00Z">
        <Hour>1.46</Hour>
    </CumulativeActiveRegenerationHours>
</CumulativeActiveRegenerationHourMessages>

CumulativeActiveRegenerationHours in time-range (MMS)

The current lifetime total non-productive regeneration hours of the machine. Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process.

  • PDC metric key used value.common.engine.hours.regeneration.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativeActiveRegenerationHourMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativeActiveRegenerationHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativeActiveRegenerationHours datetime="2018-09-03T01:06:00Z">
        <Hour>4.00</Hour>
    </CumulativeActiveRegenerationHours>
    <CumulativeActiveRegenerationHours datetime="2018-09-03T03:05:00Z">
        <Hour>1.46</Hour>
    </CumulativeActiveRegenerationHours>
</CumulativeActiveRegenerationHourMessages>

Latest CumulativePowerTakeOffHours within last 2 weeks (MMS)

Current lifetime total power take-off hours of the machine.

  • PDC metric key used value.common.machine.hours.pto.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativePowerTakeOffHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePowerTakeOffHours</href>
    </Links>
    <CumulativePowerTakeOffHours datetime="2018-09-03T00:00:00Z">
        <Hour>3.00</Hour>
    </CumulativePowerTakeOffHours>
    <CumulativePowerTakeOffHours datetime="2018-09-07T00:00:00Z">
        <Hour>2.22</Hour>
    </CumulativePowerTakeOffHours>
</CumulativePowerTakeOffHoursMessages>

CumulativePowerTakeOffHours in time-range (MMS)

Current lifetime total power take-off hours of the machine.

  • PDC metric key used value.common.machine.hours.pto.total
  • PDC unit expected predefined.unit.time.HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativePowerTakeOffHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePowerTakeOffHours/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativePowerTakeOffHours datetime="2018-09-03T01:06:00Z">
        <Hour>2.22</Hour>
    </CumulativePowerTakeOffHours>
    <CumulativePowerTakeOffHours datetime="2018-09-03T03:05:00Z">
        <Hour>3.00</Hour>
    </CumulativePowerTakeOffHours>
</CumulativePowerTakeOffHoursMessages>

Latest CumulativePayloadTotals within last 2 weeks (MMS)

Lifetime total cumulative mass of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.total
  • PDC unit expected predefined.unit.mass.KILOGRAM
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CumulativePayloadTotalMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePayloadTotals</href>
    </Links>
    <CumulativePayloadTotals datetime="2018-09-03T00:00:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1287.1</Payload>
    </CumulativePayloadTotals>
    <CumulativePayloadTotals datetime="2018-09-07T00:00:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1380.5</Payload>
    </CumulativePayloadTotals>
</CumulativePayloadTotalMessages>

CumulativePayloadTotals in time-range (MMS)

Lifetime total cumulative mass of loads the machine has achieved.

  • PDC metric key used value.common.machine.load.total
  • PDC unit expected predefined.unit.mass.KILOGRAM
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CumulativePayloadTotalMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CumulativePayloadTotals/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CumulativePayloadTotals datetime="2018-09-03T01:06:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1287.1</Payload>
    </CumulativePayloadTotals>
    <CumulativePayloadTotals datetime="2018-09-03T03:05:00Z">
        <PayloadUnits>kilogram</PayloadUnits>
        <Payload>1380.5</Payload>
    </CumulativePayloadTotals>
</CumulativePayloadTotalMessages>

Latest DEFRemaining within last 2 weeks (MMS)

The percentage of DEF remaining in the DEF tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.def.level
  • PDC unit expected predefined.unit.PERCENT

The response includes the following fields:

Note that the value for DEF tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

Field Type Description
DEFTankCapacity number This field indicates the capacity of the DEF tank. If DefTankCapacity is not available, it will send 0.
DEFTankCapacityUnits string If the DEF tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Def tank capacity shall be expressed in litre.

For machines without DEF system, refer to the table listed below:

Machines without DEF system

The following table shows how the DEF component is handled to be compliant with the MiC standard for machines that do not send any value for the DEFremaining parameter, or electric machines without a tank, or non-diesel machines.

Level is logged Capacity is set Capacity Value Values to expose Description
No No N/A None Nothing exposed.
No Yes !=0 None There might be a configuration mistake either in signal logging or capacity attribute.
No Yes =0 Level = 0 and Capacity = 0 Reflects that the DEF component is not present in this machine.
Yes No N/A Level Only the remaining level is logged.
Yes Yes Any Level and Capacity The remaining level and capacity are logged.
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<DEFRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/DEFRemaining</href>
    </Links>
      <DEFRemaining datetime=""2025-02-04T00:00:00Z">
        <Percent>78.16</Percent>
        <DEFTankCapacityUnits>litre</DEFTankCapacityUnits>
        <DEFTankCapacity>88</DEFTankCapacity>
      </FuelRemaining>
</DEFRemainingMessages>

DEFRemaining in time-range (MMS)

The percentage of DEF remaining in the DEF tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.def.level
  • PDC unit expected predefined.unit.PERCENT

The response includes the following fields:

Note that the value for DEF tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

Field Type Description
DEFTankCapacity number This field indicates the capacity of the DEF tank. If DefTankCapacity is not available, it will send 0.
DEFTankCapacityUnits string If the DEF tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Def tank capacity shall be expressed in litre.

For machines without DEF system, refer to the table listed below:

Machines without DEF system

The following table shows how the DEF component is handled to be compliant with the MiC standard for machines that do not send any value for the DEFremaining parameter, or electric machines without a tank, or non-diesel machines.

Level is logged Capacity is set Capacity Value Values to expose Description
No No N/A None Nothing exposed.
No Yes !=0 None There might be a configuration mistake either in signal logging or capacity attribute.
No Yes =0 Level = 0 and Capacity = 0 Reflects that the DEF component is not present in this machine.
Yes No N/A Level Only the remaining level is logged.
Yes Yes Any Level and Capacity The remaining level and capacity are logged.
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<DEFRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/DEFRemaining/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <DEFRemaining datetime="2018-09-03T01:06:00Z">
        <Percent>94.50</Percent>
    </DEFRemaining>
    <DEFRemaining datetime="2018-09-03T03:05:00Z">
        <Percent>26.61</Percent>
    </DEFRemaining>
</DEFRemainingMessages>

Latest EngineCondition within last 2 weeks (MMS)

Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.

  • The EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:

    • both underlying metrics have to be configured and present
    • the Running value drives the datetime in each datapoint
    • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range

  • for EngineNumber

    • PDC metric key used value.common.engine.identification.serialnumber
    • PDC unit expected predefined.unit.TEXT

  • for EngineRunning

    • PDC metric key used value.common.engine.state
    • PDC unit expected predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<EngineStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/EngineCondition</href>
    </Links>
    <EngineStatus datetime="2018-09-03T00:00:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>true</Running>
    </EngineStatus>
    <EngineStatus datetime="2018-09-07T00:00:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>false</Running>
    </EngineStatus>
</EngineStatusMessages>

EngineCondition in time-range (MMS)

Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running.

  • The EngineNumber and Running fields are populated using values that are stored separately, which has the following implications:

    • both underlying metrics have to be configured and present
    • the Running value drives the datetime in each datapoint
    • every datapoint's EngineNumber value is populated with the same, most recently reported one, irrespective of the requested time range

  • for EngineNumber

    • PDC metric key used value.common.engine.identification.serialnumber
    • PDC unit expected predefined.unit.TEXT

  • for EngineRunning

    • PDC metric key used value.common.engine.state
    • PDC unit expected predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<EngineStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/EngineCondition/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <EngineStatus datetime="2018-09-03T01:06:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>true</Running>
    </EngineStatus>
    <EngineStatus datetime="2018-09-03T03:05:00Z">
        <EngineNumber>esn20000</EngineNumber>
        <Running>false</Running>
    </EngineStatus>
</EngineStatusMessages>

Latest Faults within last 2 weeks (MMS)

Also known as DiagnosticTroubleCodes, FaultCodes. Response contains all active faults in the time range (even if the start and/or end time of the fault is outside the range).

For example, machine has following Faults:

  1. start date: 01.01.2020, end date: 02.01.2020
  2. start date: 01.01.2020, end date: 10.01.2020
  3. start date: 02.01.2020, end date: 12.01.2020
  4. start date: 03.01.2020, end date: 05.01.2020
  5. start date: 11.01.2020, end date: 12.01.2020

Request with range from 03.01.2020 to 10.01.2020 would return faults 2, 3 and 4, because they were active during the time range.

AirTemperature and TemperatureUnit appear for a DTC if all true:

  • machine PDC has value.common.cu.sensors.temperature signal and requester is permissioned to see it;
  • machine has data point for value.common.cu.sensors.temperature which is within an 1 hour before the DTC start time;
  • DTC start time is within requested timerange or not older than 30 days before requested timerange.

CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}

Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Faults</href>
    </Links>
    <FaultCode datetime="2018-09-03T00:00:00Z">
        <CodeIdentifier>676</CodeIdentifier>
        <CodeDescription>SPN: Engine Glow Plug Relay; FMI: Current Above Normal Or Grounded Circuit; Source: Brakes - System Controller; End: 2018-09-03T00:00:00Z</CodeDescription>
        <CodeSeverity>6</CodeSeverity>
        <CodeSource>11</CodeSource>
    </FaultCode>
    <FaultCode datetime="2018-09-07T00:00:00Z">
        <CodeIdentifier>677</CodeIdentifier>
        <CodeDescription>SPN: Engine Starter Motor Relay; FMI: Current Above Normal Or Grounded Circuit; Source: Brakes - System Controller; End: 2018-09-07T00:00:00Z</CodeDescription>
        <CodeSeverity>6</CodeSeverity>
        <AirTemperature>-10</AirTemperature>
        <TemperatureUnit>Celsius</TemperatureUnit>
        <CodeSource>11</CodeSource>
    </FaultCode>
</DiagnosticTroubleCode>

Faults in time-range (MMS)

Also known as DiagnosticTroubleCodes, FaultCodes. Response contains all active faults in the time range (even if the start and/or end time of the fault is outside the range).

For example, machine has following Faults:

  1. start date: 01.01.2020, end date: 02.01.2020
  2. start date: 01.01.2020, end date: 10.01.2020
  3. start date: 02.01.2020, end date: 12.01.2020
  4. start date: 03.01.2020, end date: 05.01.2020
  5. start date: 11.01.2020, end date: 12.01.2020

Request with range from 03.01.2020 to 10.01.2020 would return faults 2, 3 and 4, because they were active during the time range.

AirTemperature and TemperatureUnit appear for a DTC if all true:

  • machine PDC has value.common.cu.sensors.temperature signal and requester is permissioned to see it;
  • machine has data point for value.common.cu.sensors.temperature which is within an 1 hour before the DTC start time;
  • DTC start time is within requested timerange or not older than 30 days before requested timerange.

CodeDescription format is as follows: SPN: ${SPN description}; FMI: ${FMI description}; Source: ${fault source}; End: ${fault end time}

Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Faults/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <FaultCode datetime="2018-09-03T01:06:00Z">
        <CodeIdentifier>676</CodeIdentifier>
        <CodeDescription>SPN: Engine Glow Plug Relay; FMI: Current Above Normal Or Grounded Circuit; Source: Brakes - System Controller; End: 2018-09-03T01:06:00Z</CodeDescription>
        <CodeSeverity>6</CodeSeverity>
        <AirTemperature>-10</AirTemperature>
        <TemperatureUnit>Celsius</TemperatureUnit>
        <CodeSource>11</CodeSource>
    </FaultCode>
</DiagnosticTroubleCode>

Latest FuelRemainingRatio within last 2 weeks (MMS)

The percentage of fuel remaining in the fuel tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.fuel.level
  • PDC unit expected predefined.unit.PERCENT

Note that the value for fuel tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

The response includes the following fields:

Field Type Description
FuelTankCapacity int64, 0 to 4294967295 This field indicates the capacity of the fuel tank. The value is expressed as an unsigned integer, which includes all values from 0 to 4294967295.
FuelTankCapacityUnits string If the fuel tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Fuel tank capacity shall be expressed in litre.
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<FuelRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/FuelRemainingRatio</href>
    </Links>
      <FuelRemaining datetime="...">
        <Percent>78.16</Percent>
        <FuelTankCapacityUnits>litre</FuelTankCapacityUnits>
        <FuelTankCapacity>88</FuelTankCapacity>
      </FuelRemaining>
</FuelRemainingMessages>

FuelRemainingRatio in time-range (MMS)

The percentage of fuel remaining in the fuel tank of the machine. Only valid "percentage" values are served (i.e. any values outside of [0.0 - 100.0] range are disregarded)

  • PDC metric key used value.common.engine.fuel.level
  • PDC unit expected predefined.unit.PERCENT

Note that the value for fuel tank capacity must be maintained in the following endpoint of the REST API: https://docs.proemion.com/api/#api-Machines-patchMachinesKey.

The response includes the following fields:

Field Type Description
FuelTankCapacity int64, 0 to 4294967295 This field indicates the capacity of the fuel tank. The value is expressed as an unsigned integer, which includes all values from 0 to 4294967295.
FuelTankCapacityUnits string If the fuel tank capacity is provided, the endpoint's response will include the capacity together with the unit.
Fuel tank capacity shall be expressed in litre.
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<FuelRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/FuelRemainingRatio/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <FuelRemaining datetime="2018-09-03T01:06:00Z">
        <Percent>14.50</Percent>
    </FuelRemaining>
    <FuelRemaining datetime="2018-09-03T03:05:00Z">
        <Percent>76.61</Percent>
    </FuelRemaining>
</FuelRemainingMessages>

Latest Locations within last 2 weeks (MMS)

The last known equipment location.

  • Latitude - from Geo dataset
  • Longitude - from Geo dataset
  • Altitude - from Geo dataset
    • unit expected predefined.unit.length.METER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<LocationMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Locations</href>
    </Links>
    <Location datetime="2018-09-03T00:00:00Z">
        <Latitude>13.457124</Latitude>
        <Longitude>42.003629</Longitude>
        <Altitude>0.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
    <Location datetime="2018-09-07T00:00:00Z">
        <Latitude>23.457124</Latitude>
        <Longitude>52.003629</Longitude>
        <Altitude>212.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
    <Location datetime="2018-09-09T00:00:00Z">
        <Latitude>22.457124</Latitude>
        <Longitude>51.003629</Longitude>
        <Altitude>412.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
</LocationMessages>

Locations in time-range (MMS)

The last known equipment location.

  • Latitude - from Geo dataset
  • Longitude - from Geo dataset
  • Altitude - from Geo dataset
    • unit expected predefined.unit.length.METER
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<LocationMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/Locations/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <Location datetime="2018-09-03T01:06:00Z">
        <Latitude>23.457124</Latitude>
        <Longitude>52.003629</Longitude>
        <Altitude>212.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
    <Location datetime="2018-09-03T03:05:00Z">
        <Latitude>22.457124</Latitude>
        <Longitude>51.003629</Longitude>
        <Altitude>412.5</Altitude>
        <AltitudeUnits>metre</AltitudeUnits>
    </Location>
</LocationMessages>

Latest PeakDailySpeed within last 2 weeks (MMS)

Peak daily speed is the highest achieved travel speed for this machine. Each returned datapoint represents maximum speed during a 24-hour period ending at UTC midnight. The absence of the PeakDailySpeed tag means that no speed value was available in the time-range.

  • PDC metric key used value.common.machine.speed
  • PDC unit expected predefined.unit.speed.KILOMETERS_PER_HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<PeakDailySpeedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/PeakDailySpeed</href>
    </Links>
    <Speed datetime="2018-09-03T00:00:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>212.0</Speed>
    </Speed>
    <Speed datetime="2018-09-07T00:00:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>141.3</Speed>
    </Speed>
</PeakDailySpeedMessages>

PeakDailySpeed in time-range (MMS)

Peak daily speed is the highest achieved travel speed for this machine. Each returned datapoint represents maximum speed during a 24-hour period ending at UTC midnight. The absence of the PeakDailySpeed tag means that no speed value was available in the time-range.

  • PDC metric key used value.common.machine.speed
  • PDC unit expected predefined.unit.speed.KILOMETERS_PER_HOUR
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<PeakDailySpeedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/PeakDailySpeed/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <Speed datetime="2018-09-03T01:06:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>212.2</Speed>
    </Speed>
    <Speed datetime="2018-09-03T03:05:00Z">
        <SpeedUnits>kilometres per hour</SpeedUnits>
        <Speed>141.0</Speed>
    </Speed>
</PeakDailySpeedMessages>

Latest CautionCodes within last 2 weeks (MMS)

CautionCodes is a time-series only metric.

  • CautionMessages contains a list of CautionDescription items, populated by signals with PDC valueDefinition category StateSignal and attribute machineError=true.
  • Each CautionDescription represents the number of a code that occurred at a specific date and time.
  • Identifier and Description are taken from aempCautionCode section in the PDC. If it is absent then the state value and description are used.
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<CautionMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CautionCodes</href>
    </Links>
    <CautionDescription datetime="2018-09-03T00:00:00Z">
        <Identifier>ISO 7000-1167</Identifier>
        <Description>Transmission oil-pressure</Description>
    </CautionDescription>
    <CautionDescription datetime="2018-09-08T00:00:00Z">
        <Identifier>ISO 7000-1171</Identifier>
        <Description>Hydraulic clutch</Description>
    </CautionDescription>
</CautionMessages>

CautionCodes in time-range (MMS)

CautionCodes is a time-series only metric.

  • CautionMessages contains a list of CautionDescription items, populated by signals with PDC valueDefinition category StateSignal and attribute machineError=true.
  • Each CautionDescription represents the number of a code that occurred at a specific date and time.
  • Identifier and Description are taken from aempCautionCode section in the PDC. If it is absent then the state value and description are used.
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<CautionMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/CautionCodes/2018-09-03T01:02:03Z/2018-09-03T07:04:05Z</href>
    </Links>
    <CautionDescription datetime="2018-09-03T00:00:00Z">
        <Identifier>ISO 7000 - 1167</Identifier>
        <Description>Transmission oil-pressure</Description>
    </CautionDescription>
    <CautionDescription datetime="2018-09-08T00:00:00Z">
        <Identifier>ISO 7000 - 1167</Identifier>
        <Description>Hydraulic clutch</Description>
    </CautionDescription>
</CautionMessages>

Latest SwitchStatus within last 2 weeks (MMS)

Metric provides digital inputs state changes. The metric is time-series only.

  • SwitchStatusMessages contains a list of SwitchStatus items
  • Each SwitchStatus represents a change of status IsOn of a specific switch SwitchNumber that occurred at a specific date and time.
  • PDC metric key used value.common.machine.inputs.digital.[number] where number defines a switch number.
  • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

Responses

Response samples

Content type
application/xml
<SwitchStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/SwitchStatus</href>
    </Links>
    <SwitchStatus datetime="2018-09-03T04:02:03Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T07:14:00Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>false</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T05:20:03Z">
        <SwitchNumber>42</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
</SwitchStatusMessages>

SwitchStatus in time-range (MMS)

Metric provides digital inputs state changes. The metric is time-series only.

  • SwitchStatusMessages contains a list of SwitchStatus items
  • Each SwitchStatus represents a change of status IsOn of a specific switch SwitchNumber that occurred at a specific date and time.
  • PDC metric key used value.common.machine.inputs.digital.[number] where number defines a switch number.
  • PDC unit used predefined.unit.NUMBER, converted to boolean 0=false, !=0=true
Authorizations:
oauth2
path Parameters
OEMName
required
string

Organization name (OEMName)

model
required
string

Equipment model name

serial
required
string

Equipment serial number

startDateTime
required
string

The beginning of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

endDateTime
required
string

The end of the requested time-range (ISO-8601 timestamp format with the UTC time zone, example 2022-02-10T01:37:56Z). Max time-range allowed is 14 days.

Responses

Response samples

Content type
application/xml
<SwitchStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>/Fleet/Equipment/ID/1FTZR11U33PA93726/SwitchStatus/2018-09-03T01:02:03Z/2018-09-04T07:04:05Z</href>
    </Links>
    <SwitchStatus datetime="2018-09-03T04:02:03Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T07:14:00Z">
        <SwitchNumber>0</SwitchNumber>
        <IsOn>false</IsOn>
    </SwitchStatus>
    <SwitchStatus datetime="2018-09-03T05:20:03Z">
        <SwitchNumber>42</SwitchNumber>
        <IsOn>true</IsOn>
    </SwitchStatus>
</SwitchStatusMessages>