Alerts
GET
- machine: View machine information
OAuth Scope Required: eq1
Request URI
GET https://sandboxapi.deere.com/platform/machines/{id}/alerts
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 | Returns alerts from a specified date onward. Requests are time-based with a maximum length of seven days. Example: 2013-04-29T00:00:00Z | 24 hours before the timestamp of the request | query |
endDate | datetime | Returns alerts until a specific date. Requests are time-based with a maximum length of seven days. Example: 2013-05-02T00:00:00Z | The current time of the request | query |
alertSeverity | integer | Filters the alerts by severity1. Example: 1 | N/A | query |
excludeAcknowledged | boolean | Excludes acknowledged alerts if "true." Example: true | false | query |
Response Details
Field | Type | Description & Example |
---|---|---|
id | string | Alert ID. Example: 13243546 |
time | datetime | Time of alert. Example: 2014-10-21T 10:32:30.000Z |
location | See sample code. | Location of machine during the alert. Example: See sample code. Includes latitude and longitude. |
lat | double | Latitude Example: 53.285722 |
lon | double | Longitude Example: 42.864666 |
color | string | Alert color1. Example: YELLOW |
severity | string | Severity of the alert1. Example: MEDIUM |
acknowledgementStatus | string | Shows whether the alert was acknowledged. Values are "Y" or "N". Example: N |
ignored | boolean | Shows whether the alert was ignored Example: false |
invisible | boolean | Shows whether the alert was invisible Example: false |
duration | object | Duration of the alert. Example: See sample code. Includes "unit" and "valueAsInteger." |
unit | string | Unit of duration measurement. Example: Seconds |
valueAsInteger | integer | The duration measurement. Example: 160 |
occurrences | integer | Number of times this alert has occurred. Example: 1 |
engineHours | object | Engine hours of the machine during the alert. Example: See sample code. Includes "links," and "reading." |
reading | See sample code. | Engine hour reading. Example: See sample code. Includes "unit," and "valueAsDouble." |
unit | string | Unit of engine hour measurement. Example: hours |
valueAsDouble | double | Engine hour measurement. Example: 1528.7333 |
machineLinearTime | string | Machine's linear time during the alert. Example: 97604307 |
definition | See sample code. | Further details about the alert and alert source. Example: See sample code. Includes "suspectParameterName", "failureModeIndicator", "bus", "sourceAddress", "threeLetterAcronym", "Id", and "description". |
suspectParameterName | string | Unique Diagnostic Trouble Code identifier. See vendor equipment documentation for SPN details. Example: 12345 |
failureModeIndicator | string | Indicates the failure mode for the SPN. See vendor equipment documentation for SPN failure mode details. Example: 12 |
bus | integer | CAN (Controller Area Network) bus identifier. Example: 0 |
sourceAddress | string | CAN bus Electronic Controller Unit (ECU) source address. Example: 123 |
threeLetterAcronym | string | CAN bus Electronic Controller Unit (ECU) abbreviation. Example: AIC |
id | string | Diagnostic Trouble Code (DTC) Alert Id. Example: 12345 |
description | string | Diagnostic Trouble Code (DTC) description. Example: Other AIC 524019.31 Reverser lever left in incorrect position. - Return to park to attempt recovery. |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/machines/123456/alerts?startDate=2020-05-06T19:15:11.000Z&endDate=2020-05-13T19:15:11.000Z" } ], "total": 1, "values": [ { "@type": "DiagnosticTroubleCodeAlert", "duration": { "@type": "measurementAsInteger", "valueAsInteger": "3", "unit": "Seconds" }, "occurrences": "1", "engineHours": { "@type": "EngineHours", "reading": { "@type": "measurementAsDouble", "valueAsDouble": 668.25, "unit": "Hours" } }, "machineLinearTime": 36951157, "bus": "0", "definition": { "@type": "DiagnosticTroubleCodeAlertDefinition", "suspectParameterName": "524019", "failureModeIndicator": "31", "bus": "0", "sourceAddress": "140", "threeLetterAcronym": "AIC", "id": "1234567", "description": "Other AIC 524019.31 Reverser lever left in incorrect position. - Return to park to attempt recovery.", "links": [ { "@type": "Link", "rel": "self", "uri": "https://sandboxapi.deere.com/platform/api/alertTypes/diagnosticTroubleCodeAlert/definitions/1328105" } ] }, "id": "123456789", "time": "2020-05-13T19:15:11.000Z", "location": { "@type": "Point", "lat": 41.123456, "lon": -90.234567 }, "color": "BLUE", "severity": "INFO", "acknowledgementStatus": "N", "ignored": false, "invisible": false, "links": [ { "@type": "Link", "rel": "machine", "uri": "https://sandboxapi.deere.com/platform/machines/123456" } ] } ] }