Get Fleet List
GET
/Fleet/{pageNumber}
Retrieve a snapshot view of an equipment owner’s fleet. The API response is paginated with a page size of 100. If the response is large, it will be chunked into multiple pages. Please follow the "next" link within the response to retrieve all the fleets.
Note: The API response is cached on our servers for an hour. Hence, polling frequency of at least one hour is recommended.
Note: Not all vehicles will supply all data points.
Note: The API response is cached on our servers for an hour. Hence, polling frequency of at least one hour is recommended.
Note: Not all vehicles will supply all data points.
Request URI
GET https://sandboxaemp.deere.com/Fleet/{pageNumber} (sandbox)
GET https://partneraemp.deere.com/Fleet/{pageNumber} (live)
Accept: application/xml
Parameters
| Parameter | Type | Description & Example | Default | In |
|---|---|---|---|---|
pageNumber Required | string | Navigation to a page. Links to the current, previous, next and last pages will be provided for easy navigation Example: 1 | 100 records per page. | path |
Response Details
| Field | Type | Description & Example |
|---|---|---|
| equipmentHeader | object | See sample response below. This field includes: OEMName, Model, EquipmentID, SerialNumber, & PIN. Example: --- |
| OEMName | string | Name of equipment manufacturer. Example: JOHN DEERE |
| Model | string | Model number. Example: 260E |
| EquipmentID | string | User assigned ID. Example: 1DW260EXJEF001076 |
| SerialNumber | string | Serial number. Example: 1DW260EXJEF001076 |
| Pin | string | Assigned PIN. Example: 1DW260EXJEF001076 |
| Location | object | See below. The Location object includes: datetime, latitude, & longitude. Example: --- |
| Location-datetime | dateTime | The last time Location was updated. Example: 2017-03-22T18:35:45.000Z |
| Latitude | double | Latitude of the machine. Example: 42.573861 |
| Longitude | double | Longitude of the machine. Example: -90.709778 |
| CumulativeIdleHours | object | See below. The CumulativeIdleHours object includes datetime, & Hour. Example: --- |
| CumulativeIdleHours-datetime | dateTime | The last time CumulativeIdleHours was updated. Example: 2017-03-22T18:35:45.000Z |
| CumulativeIdleHours-Hour | double | Count of total idle hours at the given date time. Example: 180.60 |
| CumulativeLoadCount | object | See below. The CumulativeLoadCount object includes datetime, & Load. Example: --- |
| CumulativeLoadCount-datetime | dateTime | The last time CumulativeLoadCount was updated. Example: 2017-03-22T18:35:45.000Z |
| CumulativeLoadCount-Count | integer | Total count of loads. Example: 496 |
| CumulativeOperatingHours | object | See below. The CumulativeOperatingHours object includes datetime, & Hour. Example: --- |
| CumulativeOperatingHours-datetime | dateTime | The last time CumulativeOperatingHours was updated. Example: 2017-03-24T09:01:00.000Z |
| CumulativeOperatingHours-Hour | double | Count of total operating hours at the given date time. Example: 428.70 |
| CumulativePayloadTotals | object | See below. The CumulativePayloadTotals object includes datetime, PayloadUnits, & Payload. Example: --- |
| CumulativePayloadTotals-datetime | dateTime | The last time CumulativePayloadTotals was updated. Example: 2017-03-22T18:35:45.000Z |
| PayloadUnits | string | Unit of measure for the total. Example: Kilograms |
| Payload | integer | Total cumulative payload weight. Example: 499900 |
| Distance | object | See below. The Distance object includes datetime, OdometerUnits, & Odometer. Example: --- |
| Distance-datetime | dateTime | The last time Distance was updated. Example: 2017-03-22T18:35:45.000Z |
| OdometerUnits | string | Unit of measure for the total distance. Example: kilometre |
| Odometer | double | Total distance from Odometer. Example: 18871.799 |
| DEFRemaining | object | See below. The DEFRemaining object includes datetime, & Percent. Example: --- |
| DEFRemaining-datetime | dateTime | The last time DEFRemaining was updated. Example: 2017-03-22T18:35:45.000Z |
| DEFRemaining-Percent | double | Percentage of the tank with DEF remaining. Example: 34.40 |
| FuelRemaining | object | See below. The FuelRemaining object includes datetime, & Percent. Example: --- |
| FuelRemaining-datetime | dateTime | The last time FuelRemaining was updated. Example: 2017-03-22T18:35:45.000Z |
| FuelRemaining-Percent | double | Percentage of tank with fuel. Example: 48.80 |
| FuelUsed | object | See below. The FuelUsed object includes datetime, FuelUnits & FuelConsumed. Example: --- |
| FuelUsed-datetime | dateTime | The last time FuelUsed was updated. Example: 2017-03-22T18:35:45.000Z |
| FuelUnits | string | FuelUnits in litre. Example: litre |
| FuelConsumed | double | Total fuel consumed. Example: 63119 |
Sample Response [XML]
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<Fleet xmlns:itunes="http://standards.iso.org/iso/15143/-3" version="2.0" snapshotTime="2017-03-24T13:02:38.191Z">
<Links>
<Link>
<rel>self</rel>
<href>https://sandboxapi.deere.com/aemp/Fleet/1</href>
</Link>
<Link>
<rel>last</rel>
<href>https://sandboxapi.deere.com/aemp/Fleet/4</href>
</Link>
<Link>
<rel>next</rel>
<href>https://sandboxapi.com/aemp/Fleet/2</href>
</Link>
<Link>
<rel>connections</rel>
<href>https://connections.deere.com/connections/deere-sld8shg8ee0o8ns8nhdh88hn/select-organizations</href>
</Link>
</Links>
<Equipment>
<EquipmentHeader>
<OEMName>JOHN DEERE</OEMName>
<Model>260E</Model>
<EquipmentID>1DW260EXJEF001076</EquipmentID>
<SerialNumber>1DW260EXJEF001076</SerialNumber>
<PIN>1DW260EXJEF001076</PIN>
</EquipmentHeader>
<Location>
<Latitude>42.573861</Latitude>
<Longitude>-90.709778</Longitude>
</Location>
<CumulativeIdleHours>
<Hour>180.6</Hour>
</CumulativeIdleHours>
<CumulativeLoadCount>
<Count>496</Count>
</CumulativeLoadCount>
<CumulativeOperatingHours>
<Hour>428.7</Hour>
</CumulativeOperatingHours>
<CumulativePayloadTotals>
<PayloadUnits>Kilograms</PayloadUnits>
<Payload>499900</Payload>
</CumulativePayloadTotals>
<Distance>
<OdometerUnits>kilometre</OdometerUnits>
<Odometer>18871.799</Odometer>
</Distance>
<DEFRemaining>
<Percent>34.4</Percent>
</DEFRemaining>
<FuelRemaining>
<Percent>48.8</Percent>
</FuelRemaining>
<FuelUsed>
<FuelUnits>litre</FuelUnits>
<FuelConsumed>63119</FuelConsumed>
</FuelUsed>
</Equipment>
</Fleet>
