GRgroupe-psa
Trips

Vehicle's trip information.

This method returns the Trip that matches the Trip id (tid) a given Vehicle (id) has taken.

get/fleets/{fid}/vehicles/{vid}/trips/{tid}

Request

Path parameters

vidstring required

Resource is related to this Vehicle ID only.

tidstring required

The ID {tid} of Trip

fidstring required

Resource is related to this fleet ID only.

Query parameters

profile'fleet' | 'endUser'

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Response

Trip response

createdAtstring date-time required

Date when the resource has been created.

updatedAtstring date-time

Date when the resource has been updated.

idstring required

Identifier of a trip

vinstring required

Identifier of a vehicle. Set when retrieving resource in batch mode.

startedAtstring date-time

Date & Time when the trip started

stoppedAtstring date-time

Date & Time when the trip stopped

durationinteger

Duration in second of the trip

distancenumber float

Distance in km of the trip

startMileagenumber float

Vehicle mileage at the trip starting time.

doneboolean

Determines either this trip is finished or not.

Example response

{
  "_links": {
    "self": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "vehicle": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "waypoints": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "alerts": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "collisions": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    }
  },
  "vin": "VF3ABCDE0FG123456",
  "startPosition": {
    "geometry": {
      "type": "Point",
      "coordinates": [
        5.970338,
        -62.536239
      ]
    },
    "properties": {
      "vin": "VF3ABCDE0FG123456"
    }
  },
  "stopPosition": {
    "geometry": {
      "type": "Point",
      "coordinates": [
        5.970338,
        -62.536239
      ]
    },
    "properties": {
      "vin": "VF3ABCDE0FG123456"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.