AEMP API (2.9.3)

Download OpenAPI specification:Download

The Bobcat Telematics API allows you to access machine data for your fleet. The API is implemented following the AEMP Telematics standard 15143-3 provided by the Association of Equipment Management Professionals.

Once authenticated, response to every request will be sent in XML format. The responses conform to the XML Schema documents provided by the International Organization for Standardization.

Authentication

All API requests are secured using the OAuth 2.0 Client Credentials Grant. To generate a token, create a POST request to the Token endpoint.

This endpoint will reach out to the authorization server and return an access token which is used to access data from the Bobcat Telematics API. This access token is used to authenticate the remaining endpoints. It is referred to as 'authorizationToken' in the examples.

Example Request (Content-Type: "application/x-www-form-urlencoded"):

{
    "scope": "api:aemp national",
    "grant_type": "client_credentials",
    "client_id": "<YOUR_CLIENT_ID>",
    "client_secret": "<YOUR_CLIENT_SECRET>"
}

Example response:

{
    "token_type": "Bearer",
    "expires_in": 3600,
    "access_token": "<YOUR_TOKEN>",
    "scope": "api:aemp national"
}

Subscriptions

Some APIs require active Machine IQ Subscriptions to access some or all endpoints. See documentation on each API for more information.

Data Point	Basics / Standard	Health & Security / Premium
Location	X	X
Cumulative Operating Hours	X	X
Fuel Remaining	X	X
DEF Remaining	X	X
Engine Status	X	X
Diagnostic Codes		X
Fuel Used		X
Cumulative Idle Hours		X

Paging

Any endpoints that return more than one piece of equipment or list of telematics data is paged. This navigation is controlled by the page number parameter present on the endpoint URL. By default, a maximum of 100 records is returned by page.

Caching

Similar API requests will be cached for an interval of 1 minute.

Privacy Policy

https://www.bobcat.com/company-info/privacy-policy

Terms of Use

https://www.bobcat.com/company-info/terms-of-use

Telematics API (ISO 15143-3)

Telematics API operations.

Get a snapshot of a single Equipment.

This endpoint is available to all users enrolled in Machine IQ. The data points returned will be aligned to your subscription level

This endpoint will return a snapshot of the identified equipment. The identifier is the serial number.

SecurityOAuthAuthorizer

Request

path Parameters

identifier

required

string

Equipment identifier (machine serial number).

Example: abcd12345

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<Fleet version="1" snapshotTime="2020-03-30T22:43:34.760Z" xmlns="http://standards.iso.org/iso/15143/-3">
    <Equipment>
        <EquipmentHeader>
            <OEMName>Bobcat</OEMName>
            <EquipmentID>abcd12345</EquipmentID>
            <SerialNumber>abcd12345</SerialNumber>
        </EquipmentHeader>
        <Location datetime="2020-01-14T21:43:46.934Z">
            <Latitude>146.901913</Latitude>
            <Longitude>-27.211080</Longitude>
        </Location>
        <CumulativeOperatingHours datetime="2020-01-28T10:58:10.035Z">
            <Hour>220</Hour>
        </CumulativeOperatingHours>
        <DEFRemaining datetime="2020-01-14T21:36:30.299Z">
            <Percent>10.00</Percent>
        </DEFRemaining>
        <FuelUsed datetime="2020-01-14T21:36:30.3Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>60</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2020-01-14T21:36:30.299Z">
            <Percent>0.00</Percent>
        </FuelRemaining>
        <EngineStatus datetime="2020-03-26T13:15:15.274Z">
            <EngineNumber>1</EngineNumber>
            <Running>0</Running>
        </EngineStatus>
    </Equipment>
</Fleet>

Get the time series of an Equipment.

This endpoint is available to all users enrolled in Machine IQ. The data points returned will be aligned to your subscription level

This endpoint will return endpoints will return links to time-series data over the specified time for a single piece of equipment identified by serial number. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/{startDateUTC}/{endDateUTC}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<Fleet version="1" snapshotTime="2020-03-30T22:58:47.107Z" xmlns="http://standards.iso.org/iso/15143/-3">
    <Equipment>
        <EquipmentHeader>
            <OEMName>Bobcat</OEMName>
            <EquipmentID>abcd12345</EquipmentID>
            <SerialNumber>abcd12345</SerialNumber>
        </EquipmentHeader>
        <Links>
            <rel>Location</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/Locations/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Cumulative Operating Hours</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CumulativeOperatingHours/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Cumulative Idle Hours</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CumulativeIdleHours/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>DEF Remaining</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/DEFRemaining/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Engine Status</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/EngineStatus/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Fuel Used</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/FuelUsed/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Fuel Remaining</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/FuelRemaining/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Caution Codes</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CautionCodes/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Maintenance Reminders</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/MaintenanceReminders/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
    </Equipment>
</Fleet>

Get Fleet snapshot

This endpoint is available to all users enrolled in Machine IQ. The data points returned will be aligned to your subscription level

This endpoint will return a snapshot of all items for the defined page.

SecurityOAuthAuthorizer

Request

path Parameters

pageNumber

required

number

Number of a page for request pagination.

Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<Fleet version="1" snapshotTime="2020-03-06T19:30:22.955Z" xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/1</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <OEMName>Bobcat</OEMName>
            <Model>ABC123</Model>
            <EquipmentID>abcd12345</EquipmentID>
            <SerialNumber>1</SerialNumber>
            <PIN>My Machine</PIN>
        </EquipmentHeader>
        <Location datetime="2020-01-14T21:43:46.934Z">
            <Latitude>46.901913</Latitude>
            <Longitude>-97.211080</Longitude>
        </Location>
        <CumulativeOperatingHours datetime="2020-01-28T10:58:10.035Z">
            <Hour>220</Hour>
        </CumulativeOperatingHours>
        <DEFRemaining datetime="2020-01-14T21:36:30.299Z">
            <Percent>10.00</Percent>
        </DEFRemaining>
        <FuelUsed datetime="2020-01-14T21:36:30.3Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>60</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2020-01-14T21:36:30.299Z">
            <Percent>0.00</Percent>
        </FuelRemaining>
        <EngineStatus datetime="2020-03-26T13:15:15.274Z">
            <EngineNumber>1</EngineNumber>
            <Running>0</Running>
        </EngineStatus>
    </Equipment>
    <Equipment>
        <EquipmentHeader>
            <OEMName>Bobcat</OEMName>
            <Model>ACE246</Model>
            <EquipmentID>abcd2466</EquipmentID>
            <SerialNumber>abcd2466</SerialNumber>
        </EquipmentHeader>
                <Location datetime="2019-02-26T21:42:43.768Z">
            <Latitude>29.180706</Latitude>
            <Longitude>-100.339469</Longitude>
        </Location>
        <CumulativeOperatingHours datetime="2019-02-26T21:42:43.666Z">
            <Hour>500</Hour>
        </CumulativeOperatingHours>
        <DEFRemaining datetime="2019-02-26T21:42:43.666Z">
            <Percent>10.00</Percent>
        </DEFRemaining>
        <FuelUsed datetime="2019-02-26T21:42:43.666Z">
            <FuelUnits>litre</FuelUnits>
            <FuelConsumed>250</FuelConsumed>
        </FuelUsed>
        <FuelRemaining datetime="2019-02-26T21:42:43.666Z">
            <Percent>10.00</Percent>
        </FuelRemaining>
        <EngineStatus datetime="2019-04-05T18:28:33Z">
            <EngineNumber>1</EngineNumber>
            <Running>1</Running>
        </EngineStatus>
    </Equipment>
</Fleet>

Get Fleet time series.

This endpoint is available to all users enrolled in Machine IQ. The data points returned will be aligned to your subscription level

SecurityOAuthAuthorizer

Request

path Parameters

startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/FleetTS/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<Fleet version="1" snapshotTime="2020-03-30T22:59:47.941Z" xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/FleetTS/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
    </Links>
    <Equipment>
        <EquipmentHeader>
            <OEMName>Bobcat</OEMName>
            <EquipmentID>abcd12345</EquipmentID>
            <SerialNumber>abcd12345</SerialNumber>
        </EquipmentHeader>
        <Links>
            <rel>Location</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/Locations/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Cumulative Operating Hours</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CumulativeOperatingHours/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Cumulative Idle Hours</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CumulativeIdleHours/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>DEF Remaining</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/DEFRemaining/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Engine Status</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/EngineStatus/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Fuel Used</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/FuelUsed/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Fuel Remaining</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/FuelRemaining/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Caution Codes</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CautionCodes/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
        <Links>
            <rel>Maintenance Reminders</rel>
            <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/MaintenanceReminders/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
        </Links>
    </Equipment>
</Fleet>

Get the time series of Locations by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return location time series data over the specified time for a single piece of equipment identified by serial number for the defined page. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/Locations/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<LocationMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/Locations/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <Location datetime="2019-12-17T16:46:48.971Z">
        <Latitude>123.344632</Latitude>
        <Longitude>-60.040437</Longitude>
    </Location>
    <Location datetime="2020-01-14T08:54:02.136Z">
        <Latitude>81.333430</Latitude>
        <Longitude>-60.152356</Longitude>
    </Location>
    <Location datetime="2020-01-14T18:56:08.111Z">
        <Latitude>86.486700</Latitude>
        <Longitude>-80.484400</Longitude>
    </Location>
    <Location datetime="2020-01-14T21:36:34.076Z">
        <Latitude>115.800000</Latitude>
        <Longitude>-96.800000</Longitude>
    </Location>
    <Location datetime="2020-01-14T21:43:46.934Z">
        <Latitude>101.901913</Latitude>
        <Longitude>-90.211080</Longitude>
    </Location>
</LocationMessages>

Get the time series of CumulativeOperatingHours by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return cumulative operating hours time series over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with an electric motor. The range of time is specified by the start date and end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/CumulativeOperatingHours/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<CumulativeOperatingHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CumulativeOperatingHours/2018-01-14T21:43:46.934Z/2020-02-24T21:43:46.934Z/1</href>
    </Links>
    <CumulativeOperatingHours datetime="2020-01-14T21:35:56.278Z">
        <Hour>550</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2020-01-14T21:39:30.369Z">
        <Hour>1000</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2020-01-28T10:57:50.006Z">
        <Hour>209</Hour>
    </CumulativeOperatingHours>
    <CumulativeOperatingHours datetime="2020-01-28T10:58:10.035Z">
        <Hour>220</Hour>
    </CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>

Get the time series of FuelRemaining by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return fuel remaining data over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with an electric motor. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/FuelRemaining/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<FuelRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/FuelRemaining/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <FuelRemaining datetime="2020-01-14T21:35:56.278Z">
        <Percent>0.00</Percent>
    </FuelRemaining>
    <FuelRemaining datetime="2020-01-14T21:36:30.299Z">
        <Percent>0.00</Percent>
    </FuelRemaining>
</FuelRemainingMessages>

Get the time series of DEFRemaining by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return DEF remaining time series data over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with an electric motor. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/DEFRemaining/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<DEFRemainingMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/DEFRemaining/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <DEFRemaining datetime="2020-01-14T21:35:56.278Z">
        <Percent>10.00</Percent>
    </DEFRemaining>
    <DEFRemaining datetime="2020-01-14T21:36:30.299Z">
        <Percent>10.00</Percent>
    </DEFRemaining>
</DEFRemainingMessages>

Get the time series of EngineStatus by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return engine status data over the specified time for a single piece of equipment identified by serial number for the defined page. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/EngineStatus/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<EngineStatusMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/EngineStatus/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <EngineStatus datetime="2020-01-14T16:29:49.988Z">
        <EngineNumber>1</EngineNumber>
        <Running>0</Running>
    </EngineStatus>
    <EngineStatus datetime="2020-01-14T16:36:25.515Z">
        <EngineNumber>1</EngineNumber>
        <Running>1</Running>
    </EngineStatus>
    <EngineStatus datetime="2020-01-14T16:36:45.543Z">
        <EngineNumber>1</EngineNumber>
        <Running>0</Running>
    </EngineStatus>
    <EngineStatus datetime="2020-01-14T21:35:56.279Z">
        <EngineNumber>1</EngineNumber>
        <Running>1</Running>
    </EngineStatus>
</EngineStatusMessages>

Get the time series of Diagnostic Codes by Equipment (DEPRECATED).Deprecated

This endpoint is only available if your subscription provides access to this data

This endpoint will return diagnostic code time series data over the specified time for a single piece of equipment identified by serial number for the defined page. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/DiagnosticCodes/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/DiagnosticCodes/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <FaultCode datetime="2020-01-14T16:34:31.309Z">
        <CodeIdentifier>A1234</CodeIdentifier>
        <CodeSeverity>INFORMATION</CodeSeverity>
        <CodeSource>DRIVE</CodeSource>
        <CodeDescription>This fault may occur on All Wheel Steer machines.
Before a stuck wheel fault occurs, the drive system will attempt to cycle the steering valve to clear any contamination that may have caused an issue with the valve cartridge. It will log the A1234 fault in the fault log when the system tries to clear the valve. This fault is logged when any of the four steerable wheels has a stuck wheel fault. If the contamination is cleared by the cycling there will not be an associated stuck wheel fault issued. This occurrence of this fault in the log usually speaks to having contamination in the steering valves causing the wheel not to be operable by the steering control system.</CodeDescription>
    </FaultCode>
    <FaultCode datetime="2020-01-14T16:34:31.330Z">
        <CodeIdentifier>E555</CodeIdentifier>
        <CodeSource>AUXILIARY</CodeSource>
    </FaultCode>
    <FaultCode datetime="2020-02-11T19:04:49.757Z">
        <CodeIdentifier>M234</CodeIdentifier>
        <CodeSeverity>WARNING</CodeSeverity>
        <CodeSource>GATEWAY</CodeSource>
        <CodeDescription>In Stored Codes, does Code M234 "Hydraulic Oil Temperature Extremely High" also appear? Trouble shoot code M234
Refer to BATS for additional troubleshooting information</CodeDescription>
    </FaultCode>
</DiagnosticTroubleCode>

Get the time series of Diagnostic Codes by Equipment (ACTUAL).

This endpoint is only available if your subscription provides access to this data

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/Faults/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<DiagnosticTroubleCode xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/DiagnosticCodes/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <FaultCode datetime="2020-01-14T16:34:31.309Z">
        <CodeIdentifier>A1234</CodeIdentifier>
        <CodeSeverity>INFORMATION</CodeSeverity>
        <CodeSource>DRIVE</CodeSource>
        <CodeDescription>This fault may occur on All Wheel Steer machines.
Before a stuck wheel fault occurs, the drive system will attempt to cycle the steering valve to clear any contamination that may have caused an issue with the valve cartridge. It will log the A1234 fault in the fault log when the system tries to clear the valve. This fault is logged when any of the four steerable wheels has a stuck wheel fault. If the contamination is cleared by the cycling there will not be an associated stuck wheel fault issued. This occurrence of this fault in the log usually speaks to having contamination in the steering valves causing the wheel not to be operable by the steering control system.</CodeDescription>
    </FaultCode>
    <FaultCode datetime="2020-01-14T16:34:31.330Z">
        <CodeIdentifier>E555</CodeIdentifier>
        <CodeSource>AUXILIARY</CodeSource>
    </FaultCode>
    <FaultCode datetime="2020-02-11T19:04:49.757Z">
        <CodeIdentifier>M234</CodeIdentifier>
        <CodeSeverity>WARNING</CodeSeverity>
        <CodeSource>GATEWAY</CodeSource>
        <CodeDescription>In Stored Codes, does Code M234 "Hydraulic Oil Temperature Extremely High" also appear? Trouble shoot code M234
Refer to BATS for additional troubleshooting information</CodeDescription>
    </FaultCode>
</DiagnosticTroubleCode>

Get the time series of FuelUsed by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return fuel used data over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with an electric motor. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/FuelUsed/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<FuelUsedMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/FuelUsed/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <FuelUsed datetime="2020-01-14T21:35:56.279Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>0</FuelConsumed>
    </FuelUsed>
    <FuelUsed datetime="2020-01-14T21:36:30.3Z">
        <FuelUnits>litre</FuelUnits>
        <FuelConsumed>60</FuelConsumed>
    </FuelUsed>
</FuelUsedMessages>

Get the time series of CumulativeIdleHours by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return cumulative idle hours time series data over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with an electric motor. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/CumulativeIdleHours/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<CumulativeIdleHoursMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CumulativeIdleHours/2018-08-15T00:00:00Z/2020-03-24T23:59:59Z/1</href>
    </Links>
    <CumulativeIdleHours datetime="2019-04-02T00:00:00.000Z">
        <Hour>0.10</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-03T00:00:00.000Z">
        <Hour>0.10</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-04T00:00:00.000Z">
        <Hour>0.20</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-05T00:00:00.000Z">
        <Hour>0.20</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-06T00:00:00.000Z">
        <Hour>0.50</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-07T00:00:00.000Z">
        <Hour>0.80</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-08T00:00:00.000Z">
        <Hour>1.10</Hour>
    </CumulativeIdleHours>
    <CumulativeIdleHours datetime="2019-04-09T00:00:00.000Z">
        <Hour>2.10</Hour>
    </CumulativeIdleHours>
</CumulativeIdleHoursMessages>

Additional APIs

Additional APIs operations.

Get the time series of Caution Codes by Equipment.Deprecated

This endpoint is only available if your subscription provides access to this data

This endpoint will return caution code time series data over the specified time for a single piece of equipment identified by serial number for the defined page. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/CautionCodes/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<CautionMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/CautionCodes/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <CautionDescription datetime="2020-01-14T16:34:31.309Z">
        <Identifier>A1234</Identifier>
        <Description>This fault may occur on All Wheel Steer machines.
Before a stuck wheel fault occurs, the drive system will attempt to cycle the steering valve to clear any contamination that may have caused an issue with the valve cartridge. It will log the A1234 fault in the fault log when the system tries to clear the valve. This fault is logged when any of the four steerable wheels has a stuck wheel fault. If the contamination is cleared by the cycling there will not be an associated stuck wheel fault issued. This occurrence of this fault in the log usually speaks to having contamination in the steering valves causing the wheel not to be operable by the steering control system.</Description>
    </CautionDescription>
    <CautionDescription datetime="2020-01-14T16:34:31.330Z">
        <Identifier>E555</Identifier>
    </CautionDescription>
    <CautionDescription datetime="2020-02-11T19:04:49.757Z">
        <Identifier>M234</Identifier>
        <Description>In Stored Codes, does Code M234 "Hydraulic Oil Temperature Extremely High" also appear? Trouble shoot code M234
Refer to BATS for additional troubleshooting information</Description>
    </CautionDescription>
</CautionMessages>

Get the time series of StateOfCharge by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return state of charge data over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with a diesel engine. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/StateOfCharge/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

Get the time series of Maintenance Reminders by Equipment.Deprecated

This endpoint is only available if your subscription provides access to this data

This endpoint will return maintenance reminders time series data over the specified time for a single piece of equipment identified by serial number for the defined page. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/MaintenanceReminders/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<MaintenanceReminders xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/MaintenanceReminders/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <MaintenanceReminderDescription datetime="2019-12-02T19:21:36.797Z">
        <Message>Regular 250 Hour Maintenance Due – 123456789 123456789 1234567890</Message>
        <MaintenanceInterval>250</MaintenanceInterval>
        <MaintenanceKitDescription>Maintenance Kit Description</MaintenanceKitDescription>
        <MaintenanceKitPartNumber>12345</MaintenanceKitPartNumber>
        <MaintenanceParts>12345</MaintenanceParts>
        <LastLocation>250 E Beaton Dr Fargo, ND 58103 US</LastLocation>
        <Model>E123 T1</Model>
        <OperatingHours>510</OperatingHours>
        <ServicingDealer>
            <Name>Maintenance Company, Inc, Moorhead, MN</Name>
            <Phone>1234</Phone>
        </ServicingDealer>
    </MaintenanceReminderDescription>
</MaintenanceReminders>

Get the time series of Machine Battery Voltage by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return machine battery voltage data over the specified time for a single piece of equipment identified by serial number for the defined page. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/MachineBatteryVoltage/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<MachineBatteryVoltageMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/MachineBatteryVoltage/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <MachineBatteryVoltage datetime="2020-01-14T21:35:56.279Z">
        <Voltage>0</Voltage>
    </MachineBatteryVoltage>
    <MachineBatteryVoltage datetime="2020-01-14T21:36:30.3Z">
        <Voltage>60</Voltage>
    </MachineBatteryVoltage>
</MachineBatteryVoltageMessages>

Get the time series of Engine Coolant Temperature by Equipment.

This endpoint is only available if your subscription provides access to this data

This endpoint will return coolant temperature data over the specified time for a single piece of equipment identified by serial number for the defined page. This endpoint will return Not Found error for equipment with an electric motor. The range of time is specified by the start date and the end date.

SecurityOAuthAuthorizer

Request

path Parameters

identifier required	string Equipment identifier (machine serial number). Example: abcd12345
startDateUTC required	string Start date of the time series range in UTC time zone format. Example: 2018-01-14T21:43:46.934Z
endDateUTC required	string End date of the time series range in UTC time zone format. Example: 2020-01-14T21:43:46.934Z
pageNumber required	number Number of a page for request pagination. Example: 1

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/EngineCoolantTemperature/{startDateUTC}/{endDateUTC}/{pageNumber}

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<EngineCoolantTemperatureMessages xmlns="http://standards.iso.org/iso/15143/-3">
    <Links>
        <rel>self</rel>
        <href>https://aemp.api.bobcat.com/Fleet/Equipment/abcd12345/EngineCoolantTemperature/2018-01-14T21:43:46.934Z/2020-01-14T21:43:46.934Z/1</href>
    </Links>
    <EngineCoolantTemperature datetime="2020-01-14T16:29:49.988Z">
        <Celsius>0</Celsius>
    </EngineCoolantTemperature>
    <EngineCoolantTemperature datetime="2020-01-14T21:35:56.279Z">
        <Celsius>60</Celsius>
    </EngineCoolantTemperature>
</EngineCoolantTemperatureMessages>

Get WarrantyStatus by Equipment.

This endpoint is only available if your subscription provides access to this data

SecurityOAuthAuthorizer

Request

path Parameters

identifier

required

string

Equipment identifier (machine serial number).

Example: abcd12345

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/WarrantyStatus

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<Error>
  <status>400</status>
  <errorType>Bad Request</errorType>
  <exception>BadRequestException</exception>
  <message>errorId: $context.requestId URL string invalid</message>
</Error>

Get FieldMods by Equipment.

This endpoint is only available if your subscription provides access to this data

SecurityOAuthAuthorizer

Request

path Parameters

identifier

required

string

Equipment identifier (machine serial number).

Example: abcd12345

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

get/Fleet/Equipment/{identifier}/FieldMods

Request samples

curl
Node.js
Java
C#

Response samples

text/xml

<?xml version="1.0" encoding="UTF-8"?>
<Error>
  <status>400</status>
  <errorType>Bad Request</errorType>
  <exception>BadRequestException</exception>
  <message>errorId: $context.requestId URL string invalid</message>
</Error>

Update Equipment Id Attribute.

This endpoint is only available if your subscription provides access to this data

This endpoint will update the Equipment ID of the asset.

SecurityOAuthAuthorizer

Request

header Parameters

Authorization

required

string

Example: Bearer {authorizationToken}

Request Body schema: application/json

Array

serialNumber	string
equipmentId	string

Responses

200

Successful response

400

Bad request response

401

Unauthorized response

403

Forbidden response

404

Not found response

500

Internal server error response

501

Not implemented response

post/Fleet/Equipment/UpdateEquipmentId

Request samples

Payload
curl
Node.js
Java
C#

application/json

[{"serialNumber": "abcd12345",
"equipmentId": 1234321
}
]

Response samples

application/json

[{"key": "abcd12345",
"status": "success",
"reason": ["Thing 'abcd12345' not found"
]
}
]