List trips
get
/fleetMonitoring/clientapi/v2/trips
This operation returns the list of all the trips existing for the current Oracle IoT Fleet Monitoring Application instance.
Note :
Trips can be filtered based on fields like startTime, endTime, lastModifiedTime etc. using MongoDB style query.
Example :
https://iotserver:443/fleetMonitoring/clientapi/v2/trips?q={"startTime":{"$gt":1527685009925,"$lt":1527686009925}}
Note :
Trips can be filtered based on fields like startTime, endTime, lastModifiedTime etc. using MongoDB style query.
Example :
https://iotserver:443/fleetMonitoring/clientapi/v2/trips?q={"startTime":{"$gt":1527685009925,"$lt":1527686009925}}
Request
Query Parameters
-
expand(optional): string
The list of fields to be expanded in the result. Use 'all' to expand all expandable fields in result.
-
fields(optional): string
The comma-separated list of fields to be shown in response. By default all response object fields will be present.
-
limit(optional): integer
The maximum number of entries to return to the end user.
-
offset(optional): integer
The number that the first record of results is starting from.
-
orderBy(optional): string
Ordering criteria for the returned trips' list.
-
q(optional): string
Query to filter trips on the app. (For more information on mongoDB query parameters refer to Using mongoDB Query Syntax.)
-
since(optional): integer
The starting point of the desired time interval, in milliseconds. The default is 0.
-
totalResults(optional): boolean
The total number of results suiting the request.
-
until(optional): integer
The finishing point of the desired time interval, in milliseconds. The default is 0.
Header Parameters
-
X-ORACLE-IOT-ORG(optional): string
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
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : TripImpl_receive_list
Type:
Show Source
object-
count:
integer(int32)
-
hasMore:
boolean
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
The set of API navigation links.
-
offset:
integer(int32)
Nested Schema : items
Type:
Show Source
object-
destination:
object TripStopRecord_receive
-
driver:
object TripDriverInfoModel_receive
-
driverId:
string
ID of the driver associated with the trip
-
earliestStartTime:
integer
Trip planned earliest start time (epoch time in milliseconds)
-
endTime:
integer
Trip end time (epoch time in milliseconds)
-
expectedDuration:
integer
Expected duration of the Trip (seconds) : Taken from Trip planning info; if not provided then retrieved from MapServiceProvider, else set as 0
-
id:
string
Trip ID
-
lastModifiedTime:
integer
Last modified time (epoch time in milliseconds)
-
latestStartTime:
integer
Trip planned latest start time (epoch time in milliseconds)
-
name:
string
Trip name
-
plannedDriveDistance:
integer
Total planned length of the trip
-
plannedDriveDurationSeconds:
integer
Total planned drive duration of the trip in seconds
-
source:
object TripStopRecord_receive
-
startTime:
integer
Trip start time (epoch time in milliseconds)
-
stops:
array stops
List of stops for the trip
-
stopsClassification:
string
One of [SINGLE_STOP, DUAL_STOP, TRIPLE_STOP, MULTI_STOP, NON_STOP].
-
stopsCompleted:
integer
Number of stops completed for the trip
-
totalStops:
integer
Total stops for the trip
-
tripContext:
array tripContext
List of Trip Context for the trip
-
tripLength:
number
Total length of the Trip
-
tripLengthClassification:
string
One of [SHORT, MEDIUM, LONG].
-
tripStatus:
string
One of [NOT_STARTED, IN_PROGRESS, COMPLETED, CANCELLED].
-
tripTemplateId:
string
ID of the tripTemplate associated with the trip
-
tripType:
string
Trip type either Planned or Automatic trip
-
vehicle:
object TripVehicleInfoModel_receive
-
vehicleId:
string
ID of the vehicle associated with this trip
Nested Schema : TripStopRecord_receive
Type:
Show Source
object-
address:
string
Unified full address, e.g. 500 Oracle Parkway::Redwood City::CA::US::94065 . Must be provided if geoLocation is not specified.
-
arrivalTime:
integer
Trip arrival time (millisecond)
-
city:
string
Name of City
-
country:
string
Name of country
-
departureTime:
integer
Trip departure time (millisecond)
-
distanceToNextStop:
number
Estimated distance to next stop
-
estimatedArrivalTime:
integer
Estimated arrival time (millisecond)
-
estimatedDepartureTime:
integer
Estimated departure time (millisecond)
-
estimatedTimeToNextStop:
integer
Estimated time it will take to reach next stop (second)
-
expectedDurationFromStart:
integer
Expected duration from Start to arrive at this Stop (seconds)
-
geoLocation:
object GeoPosition_receive
-
plannedArrivalTime:
integer
Planned Trip arrival time (in millisecond)
-
plannedDepartureTime:
integer
Planned Trip departure time (in millisecond)
-
postalCode:
string
Postal/Zip code
-
state:
string
Name of State
-
stopDurationInSeconds:
integer
Stop duration in seconds
-
stopSequence:
integer
Sequence number of the stop
-
stopType:
string
The reason for stopping
-
street:
string
Name of Street
-
timeZone:
string
Time zone of the time fields
Nested Schema : TripDriverInfoModel_receive
Type:
Show Source
object-
externalId:
string
External Id of the driver associated with this trip
-
loginId:
string
Login Id of the driver associated with this trip
-
name:
string
Name of the driver associated with this trip
Nested Schema : TripVehicleInfoModel_receive
Type:
Show Source
object-
name:
string
Name of the vehicle assigned to the trip
-
registrationNumber:
string
Registration number of the vehicle assigned to the trip
-
type:
string
Type of the vehicle assigned to the trip
Nested Schema : GeoPosition_receive
Type:
Show Source
object-
additionalElements:
array additionalElements
Property description was not set
-
altitude:
number
Property description was not set
-
latitude:
number
Property description was not set
-
longitude:
number
Property description was not set
-
valid:
boolean
Property description was not set
Nested Schema : TripModel$TripContext_receive
Type:
Show Source
object-
externalId:
string
The ID of the shipment in the external system, in case of connected systems
-
name:
string
Trip Context name
-
type:
string
Trip Context type either Shipment or default trip
-
value:
string
Trip Context Id, either Trip or Shipment Id
Nested Schema : items
Type:
Show Source
object-
href(optional):
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path -
rel(optional):
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/trips
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"items": [
{
"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/fleetMonitoring/clientapi/v2/vehicles/09DE39F0-A091-46B7-B0E9-3C21CC56EFE5",
"rel": "vehicle"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers/7BE01256-8567-44BF-8DA3-8AEE26F33F35",
"rel": "driver"
}
]
},
{
"id": "DA50A721-5F06-4D3D-ACDB-BE85F10BB696",
"name": "HQ-SFO-SCA-Vehicle_Name",
"driverId": "E8E8B1E4-0D8A-4ECB-95CA-A555510D3D49",
"vehicleId": "9E921611-F05A-4356-BE40-107E63CA480F",
"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": 1519811366198,
"plannedDepartureTime": 1519811366198,
"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": 1519984166198,
"plannedDepartureTime": 1519984166198,
"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": 1519854566198,
"plannedDepartureTime": 1519854566198,
"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": 1519811366319,
"endTime": -1,
"tripLength": 68.35083089999999,
"lastModifiedTime": 1519811366415,
"stopsCompleted": 0,
"totalStops": 1,
"stopsClassification": "SINGLE_STOP",
"tripLengthClassification": "SHORT",
"tripContext": [
{
"value": "DA50A721-5F06-4D3D-ACDB-BE85F10BB696",
"name": "HQ-SFO-SCA-Vehicle_Name",
"type": "TRIP"
}
],
"links": [
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles/9E921611-F05A-4356-BE40-107E63CA480F",
"rel": "vehicle"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers/E8E8B1E4-0D8A-4ECB-95CA-A555510D3D49",
"rel": "driver"
}
]
}
],
"links": [
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/trips?offset=0&limit=10",
"rel": "self"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/trips",
"rel": "canonical"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/trips?offset=0&limit=10",
"rel": "first"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/trips?offset=0&limit=10",
"rel": "last"
}
],
"offset": 0,
"limit": 10,
"count": 1,
"hasMore": false
}
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
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.