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.
Header Parameters
  • To allow targeting requests to different organizations. The header value should contain the organization identifier(orgId). This header is optional, if not provided orgId will be ORA_DEFAULT_ORG
Back to Top

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 : TripDriverInfoModel_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 : GeoPosition_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

Request 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.
Back to Top

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:

{
    "id": "D9B17614-5112-41B4-AA02-981C8F6C49F8",
    "name": "HQ-SFO-SCA-Vehicle_Name",
    "driverId": "7BE01256-8567-44BF-8DA3-8AEE26F33F35",
    "vehicleId": "09DE39F0-A091-46B7-B0E9-3C21CC56EFE5",
    "source": {
        "address": "500 Oracle Parkway::Redwood City::CA::US::94065",
        "geoLocation": [
            -122.26223,
            37.53084
        ],
        "estimatedTimeToNextStop": 1945,
        "distanceToNextStop": 23.997354694103965,
        "expectedDurationFromStart": 0,
        "city": "Redwood City",
        "country": "US",
        "plannedArrivalTime": 1519810576752,
        "plannedDepartureTime": 1519810576752,
        "postalCode": "94065",
        "state": "CA",
        "stopDurationInSeconds": 0,
        "street": "500 Oracle Parkway",
        "stopSequence": 0
    },
    "destination": {
        "address": "4210 Network Circle::Santa Clara::CA::US::95054",
        "geoLocation": [
            -121.95267,
            37.39124
        ],
        "estimatedTimeToNextStop": 0,
        "distanceToNextStop": 0,
        "expectedDurationFromStart": 172800,
        "city": "Santa Clara",
        "country": "US",
        "plannedArrivalTime": 1519983376752,
        "plannedDepartureTime": 1519983376752,
        "postalCode": "95054",
        "state": "CA",
        "stopDurationInSeconds": 0,
        "street": "4210 Network Circle",
        "stopSequence": 1
    },
    "stops": [
        {
            "address": "475 Sansome Street::San Francisco::CA::US::94111",
            "geoLocation": [
                -122.40143,
                37.79461
            ],
            "estimatedTimeToNextStop": 3100,
            "distanceToNextStop": 44.78222147367256,
            "expectedDurationFromStart": 43200,
            "city": "San Francisco",
            "country": "US",
            "plannedArrivalTime": 1519853776752,
            "plannedDepartureTime": 1519853776752,
            "postalCode": "94111",
            "state": "CA",
            "stopDurationInSeconds": 0,
            "street": "475 Sansome Street",
            "stopSequence": 2
        }
    ],
    "tripStatus": "IN_PROGRESS",
    "earliestStartTime": 1528957500000,
    "latestStartTime": 1528959500000,
    "plannedDriveDistance": 560,
    "plannedDriveDurationSeconds": 72000,
    "expectedDuration": 5046,
    "startTime": 1519810577014,
    "endTime": -1,
    "tripLength": 68.35083089999999,
    "lastModifiedTime": 1519810577304,
    "stopsCompleted": 0,
    "totalStops": 1,
    "stopsClassification": "SINGLE_STOP",
    "tripLengthClassification": "SHORT",
    "tripContext": [
        {
            "value": "D9B17614-5112-41B4-AA02-981C8F6C49F8",
            "name": "HQ-SFO-SCA-Vehicle_Name",
            "type": "TRIP"
        }
    ],
    "links": [
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/trips/D9B17614-5112-41B4-AA02-981C8F6C49F8/",
            "rel": "self"
        },
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/trips/D9B17614-5112-41B4-AA02-981C8F6C49F8/",
            "rel": "canonical"
        },
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/vehicles/09DE39F0-A091-46B7-B0E9-3C21CC56EFE5",
            "rel": "vehicle"
        },
        {
            "href": "https://iotserver:443/fleetMonitoring/clientapi/v2/drivers/7BE01256-8567-44BF-8DA3-8AEE26F33F35",
            "rel": "driver"
        }
    ]
}



Complete cURL Example

The following example shows a complete cURL command that you can use 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.
Back to Top