1. REST API for Oracle IoT Fleet Monitoring Cloud Service
  2. Tasks
  3. Trip Management

Retrieve trip details

get

/fleetMonitoring/clientapi/v2/trips/{tripId}

This operation returns information about a trip that is specified by its ID.

Request

Path Parameters
Query Parameters
  • The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
  • The comma-separated list of fields to be shown in response. By default all response object fields will be present.

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : TripImpl_receive
Type: object
Show Source
Nested Schema : TripStopRecord_receive
Type: object
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : stops
Type: array
List of stops for the trip
Show Source
Nested Schema : tripContext
Type: array
List of Trip Context for the trip
Show Source
Nested Schema : TripVehicleInfoModel_receive
Type: object
Show Source
Nested Schema : additionalElements
Type: array
Property description was not set
Show Source
Nested Schema : TripModel$TripContext_receive
Type: object
Show Source

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

406 Response

Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

Examples

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/trips/{tripId}

Example of Response Body

The following example shows the content of the response body in JSON format: 


{
    "lastModifiedTime":1469184297746,
    "tripTrackingStatus":"One of [ON_TIME, DELAYED].",
    "totalStops":12345,
    "destination":{
        "departureTime":1469184297746,
        "stopDurationInSeconds":12345,
        "distanceToNextStop":0.0,
        "country":"Name of country",
        "stopSequence":12345,
        "address":"Unified full address, e.g. 110 Scottsville Center::Scottsville::VA::US::24590 . Must be provided if geoLocation is not specified.",
        "city":"Name of City",
        "plannedArrivalTime":1469184297746,
        "postalCode":"Postal/Zip code",
        "expectedDurationFromStart":12345,
        "timeZone":"Time zone of the time fields",
        "plannedDepartureTime":1469184297746,
        "stopType":"The reason for stopping",
        "estimatedTimeToNextStop":1469184297746,
        "estimatedDepartureTime":1469184297746,
        "geoLocation":[longitude,latitude],
        "arrivalTime":1469184297746,
        "street":"Name of Street",
        "state":"Name of State",
        "estimatedArrivalTime":1469184297746
    },
    "stopsClassification":"One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].",
    "source":{
        "departureTime":1469184297746,
        "stopDurationInSeconds":12345,
        "distanceToNextStop":0.0,
        "country":"Name of country",
        "stopSequence":12345,
        "address":"Unified full address, e.g. 110 Scottsville Center::Scottsville::VA::US::24590 . Must be provided if geoLocation is not specified.",
        "city":"Name of City",
        "plannedArrivalTime":1469184297746,
        "postalCode":"Postal/Zip code",
        "expectedDurationFromStart":12345,
        "timeZone":"Time zone of the time fields",
        "plannedDepartureTime":1469184297746,
        "stopType":"The reason for stopping",
        "estimatedTimeToNextStop":1469184297746,
        "estimatedDepartureTime":1469184297746,
        "geoLocation":[longitude,latitude],
        "arrivalTime":1469184297746,
        "street":"Name of Street",
        "state":"Name of State",
        "estimatedArrivalTime":1469184297746
    },
    "unauthorizedStopsCount":12345,
    "idlingDurationViolationCount":12345,
    "vehicle":{
        "registrationNumber":"vehicle registration number",
        "name":"vehicle name",
        "id":"24006bc01dbd-3a68"
    },
    "totalStopDuration":12345,
    "tripContext":[
        {
            "name":"Trip Context name",
            "externalId":"6e5e57fd7ad2-5c14",
            "type":"Trip Context type either Shipment or default trip",
            "value":"Trip Context Id, either Trip or Shipment Id"
        }
    ],
    "speedViolationCount":12345,
    "eta":12345,
    "fuelConsumed":0.0,
    "tripLengthClassification":"One of [SHORT, MEDIUM, LONG].",
    "startTime":1469184297746,
    "id":"37bc559651e1-6efb",
    "vehicleId":"35ed527346f6-6d69",
    "consumedFuelCost":0.0,
    "distanceTraveled":0.0,
    "tripLength":0.0,
    "incidentCount":12345,
    "expectedDuration":12345,
    "estimatedDelay":12345,
    "fenceViolationCount":12345,
    "tripTemplateId":"6ea2e01b7-210e",
    "driverId":"6a606ac61ac-d81",
    "geoLocation":[longitude,latitude],
    "alertCount":12345,
    "percentageComplete":0.0,
    "name":"Trip name",
    "stops":[
        {
            "departureTime":1469184297746,
            "stopDurationInSeconds":12345,
            "distanceToNextStop":0.0,
            "country":"Name of country",
            "stopSequence":12345,
            "address":"Unified full address, e.g. 110 Scottsville Center::Scottsville::VA::US::24590 . Must be provided if geoLocation is not specified.",
            "city":"Name of City",
            "plannedArrivalTime":1469184297746,
            "postalCode":"Postal/Zip code",
            "expectedDurationFromStart":12345,
            "timeZone":"Time zone of the time fields",
            "plannedDepartureTime":1469184297746,
            "stopType":"The reason for stopping",
            "estimatedTimeToNextStop":1469184297746,
            "estimatedDepartureTime":1469184297746,
            "geoLocation":[longitude,latitude],
            "arrivalTime":1469184297746,
            "street":"Name of Street",
            "state":"Name of State",
            "estimatedArrivalTime":1469184297746
        }
    ],
    "endTime":1469184297746,
    "tripStatus":"One of [IN_PROGRESS, COMPLETED, CANCELLED].",
    "elapsedDuration":12345
}



Complete cURL Example

The following example shows the complete cURL command that can be used to perform the described operation:

curl -X GET 
   -u <username>:<password> 
   -H 'Accept: application/json' 
   https://iotserver/fleetMonitoring/clientapi/v2/trips/{tripId}



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https://myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.