Skip to main content

Web API – Trips

Updated over a week ago

List Trips

Request URL

Query parameters

  • startDate – Format ‘yyyy-mm-dd’, e.g. ‘2015-01-31’ means midnight Jan 31, 2015 at your local timezone. Inclusive.

  • endDate – Format ‘yyyy-mm-dd’, e.g. ‘2015-12-31’. Inclusive.

  • userEmail – Email address of a particular user to search for.

  • activity – Trip activity, e.g. ‘Business’.

  • minLastUpdated – The date when the record was modified or created. Format ‘yyyy-mm-dd’. Inclusive.

  • maxLastUpdated – The date when the record was modified or created. Format ‘yyyy-mm-dd’. Inclusive.

  • status – Approval status. Valid options are: ‘U’ – not submitted, ‘S’ – submitted, ‘A’ – approved, ‘R’ – rejected, ‘P’ – pay scheduled.

Note

You need to provide at least one of the query parameters in the request.
The returned DateTime in the response is in the UTC time zone as in the JSON standard.

There is an internal rate limit for the date range, which limits it to one year. When pulling a trips list the difference between Start date - End date should be less than or equal to 1 year. If there is a larger time frame a time out error will be returned.

Example

Example Return

{
"id": 999999,
"url": "https://www.triplogmileage.com/web/api/trips/999999",
"lastUpdated": "2023-09-18T19:25:29.049Z",
"user": {
"id": 000003,
"url": "https://www.triplogmileage.com/web/api/users/000003",
"email": "[email protected]",
"display": "User, Demo"
},
"vehicle": {
"id": 222222,
"url": "https://www.triplogmileage.com/web/api/vehicles/222222",
"lastUpdated": "2023-03-27T22:37:01.417Z",
"display": "2018 Default Vehicle "
},
"startTime": "2023-09-06T00:34:00.000Z",
"endTime": "2023-09-06T01:00:00.000Z",
"startOdometer": 618,
"endOdometer": 631,
"mileage": 13.4,
"fromLocation": {
"id": 333333,
"url": "https://www.triplogmileage.com/web/api/locations/333333",
"lastUpdated": "2023-04-21T19:43:00.913Z",
"display": "FW Greens",
"name": "FW Greens",
"address": "1234 N Main St, AnytownUSA, NC 12345"
},
"toLocation": {
"id": 444444,
"url": "https://www.triplogmileage.com/web/api/locations/444444",
"lastUpdated": "2023-08-02T01:13:05.783Z",
"display": "4321 Front St, AnytownUSA, NC 12345",
"name": null,
"address": "4321 Front St, AnytownUSA, NC 12345"
},
"activity": "Business",
"parking": 0.0,
"toll": 0.0,
"tags": null,
"notes": null,
"status": "S",
"statusUpdateTime": "2023-09-18T19:25:29.000Z",
"statusUpdatedBy": {
"id": 000002,
"url": "https://www.triplogmileage.com/web/api/users/000002",
"email": "[email protected]",
"display": "User, Admin"
},
"polyline": null,
"route": "https://www.triplogmileage.com/web/api/trips/xxxxxx/routes",
"receipts": "https://www.triplogmileage.com/web/api/trips/xxxxxx/receipts",
"map": "https://www.triplogmileage.com/web/kml/embed/xxxxxx.kml",
"trackingMethod": "MagicTrip",
"updateMethod": null,
"scale": 0.0,
"lumpers": 0.0,
"perDiem": false,
"stayTimeMins": 50191

Update Trip

Request URL

Query parameters

None

JSON request data

Specify the fields you want to change. Leaving it out or setting to ‘null’ means no change to that field.

{
“tags” : String (optional),
“notes” : String (optional),
“toll” : float (optional),
“parking”: float (optional),
“scale”: float (optional),
“lumpers”: float (optional),
“activity” : String (optional) Business Personal …
}

Did this answer your question?