Machine Location History
GET
OAuth Scope Required: eq1
Request URI
GET https://sandboxapi.deere.com/platform/machines/{id}/locationHistory
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | Default | In |
---|---|---|---|---|
id Required | string | Machine Id Example: 5432 | N/A | path |
lastKnown | boolean | Includes the last known machine location. Example: false | N/A | query |
startDate | datetime | Retrieves results that occurred after a specified date.If start date is not passedin the API request then start Date is considered as end date minus 1 day. The format is in the ISO 8601 Standard. Example: 2010-10-04T14:35:05.000Z | N/A | query |
endDate | datetime | Retrieves results that occurred before a specified date. If end date is not passed in the API requestthen end Date is considered as start date plus 1 day. The format is in the ISO 8601 Standard.Also startDate and endDate time interval range should be <=1 month.Example if startDate=2020-10-01T00:00:00.000Z endDate should be <=2010-10-31T23:59:59.000Z Example: 2010-10-04T14:38:35.000Z | N/A | query |
Response Details
Field | Type | Description & Example |
---|---|---|
point | N/A | Contains the <lat>, <lon>, and <altitude> tags. Example: N/A |
lat | double | The latitude of the machine's location. Example: 41.688612 |
lon | double | The longitude of the machine's location. Example: -93.693612 |
altitude | measurement AsDouble | The altitude of the machine's location. The value and unit of measurement are both included. Example: See sample response below. |
eventTimestamp | datetime | Timestamp of the machine location report. All timestamps follow the ISO 8601 standard format. Example: 2012-11-07T18:42:07.186Z |
gpsFixTimestamp | datetime | The last time the machine noted its GPS location. Example: 2010-10-04T15:06:24.000Z |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/machines/4321/locationHistory" } ], "total": 2, "values": [ { "point": { "lat": 41.597164, "lon": -90.54383, "altitude": { "@type": "measurementAsDouble", "valueAsDouble": 0, "links": null, "unit": "meters" }, "links": null }, "eventTimestamp": "2010-10-20T22:32:16.000Z", "gpsFixTimestamp": "1970-01-01T00:00:00.000Z", "links": [ { "rel": "machine", "uri": "https://sandboxapi.deere.com/platform/machines/4321" } ] }, { "point": { "lat": 41.597305, "lon": -90.543884, "altitude": { "@type": "measurementAsDouble", "valueAsDouble": 0, "links": null, "unit": "meters" }, "links": null }, "eventTimestamp": "2010-10-04T15:06:34.000Z", "gpsFixTimestamp": "2010-10-04T15:06:24.000Z", "links": [ { "rel": "machine", "uri": "https://sandboxapi.deere.com/platform/machines/4321" } ] } ] }