Hours of Operation
GET
Note: When the terminal is powered off, hours of operation are not recorded.
OAuth Scope Required: eq1
Request URI
GET https://sandboxapi.deere.com/platform/machines/{id}/hoursOfOperation
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | Default | In |
---|---|---|---|---|
id Required | string | Machine ID. Example: 5432 | N/A | path |
startDate | datetime | Filters hours of operation starting from a specified date. Request date as UTC Timestamp. Example: 2013-04-29T00:00:00Z | N/A | query |
endDate | datetime | Filters hours of operation before a specified date. Request date as UTC Timestamp. Example: 2013-04-30T23:30:00Z | N/A | query |
detailedState | string | detailedState Example: PTOStatus or genericMachineUtilization or genericEngineUtilization | query |
Response Details
Field | Type | Description & Example |
---|---|---|
startDate | datetime | Time at which the machine started. Returns a UTC Timestamp. Example: 2013-04-29T00:00:00Z |
endDate | datetime | Time at which the machine stopped. Returns a UTC Timestamp. Example: 2013-04-30T23:30:00Z |
engineState | integer | The returned value indicates the current state of the engine1 Example: 1 |
detailedState | string | The returned value indicates the user queried definedType value. Example: PTO Status On |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/machines/5432/hoursOfOperation" } ], "total": 2, "values": [ { "links": [ { "rel": "machine", "uri": "https://sandboxapi.deere.com/platform/machines/5432" } ], "startDate": "2013-04-29T00:00:00Z", "endDate": "2013-04-30T00:00:00Z", "engineState": 0, "detailedState": "PTO Status On" }, { "links": [ { "rel": "machine", "uri": "https://sandboxapi.deere.com/platform/machines/5432" } ], "startDate": "2013-04-29T00:00:00Z", "endDate": "2013-04-30T00:00:00Z", "engineState": 0, "detailedState": "PTO Status On" } ] }