List drivers
get
/fleetMonitoring/clientapi/v2/drivers
This operation returns the list of all the drivers registered with the current application instance.
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 FM drivers list.
-
q(optional): string
Query to filter FM drivers on the server. (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.
Response
Supported Media Types
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
Successfully processed.
Root Schema : Driver_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
-
dutyStatus:
string
DutyStatus one of [OFF_DUTY, DRIVING, SLEEPER_BERTH, ON_DUTY_NOT_DRIVING]One of [OFF_DUTY, DRIVING, SLEEPER_BERTH, ON_DUTY_NOT_DRIVING].
-
id:
string
Driver ID
-
lastModifiedBy:
string
Driver last modified by
-
lastModifiedTime:
integer
Time when driver was last modified (millisecond)
-
lastModifiedTimeAsString:
string
Time when driver was last modified, as String
-
loginId:
string
Driver's Login ID
-
metricResultMap:
object MetricMap_receive
-
mobileNumber:
string
Driver mobile number
-
name:
string
Driver name
-
registeredBy:
string
Driver registered by
-
registrationTime:
integer
Registration time of the driver (millisecond)
-
registrationTimeAsString:
string
Registration time of the driver, as String
-
tripId:
string
ID of the trip corresponding to the driver
-
vehicleId:
string
ID of the vehicle assigned to the driver
Nested Schema : MetricMap_receive
Type:
Show Source
object
-
metricResults:
array metricResults
The metric result lists of an entity.
Nested Schema : Metric_receive
Type:
Show Source
object
-
booleanValue:
boolean
Property description was not set
-
computedTime:
integer
Property description was not set
-
confidenceLevel:
integer
Property description was not set
-
entityId:
string
Property description was not set
-
entityType:
string
Property description was not set
-
eventTime:
integer
Property description was not set
-
eventTimeAsString:
string
Property description was not set
-
geoLocationValue:
object GeoPosition_receive
-
id:
string
Property description was not set
-
interval:
string
One of [CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, NEXT7DAYS, NEXT30DAYS].
-
lastKnown:
boolean
Property description was not set
-
name:
string
Property description was not set
-
numericValue:
integer
Property description was not set
-
params:
object params
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
stringValue:
string
Property description was not set
-
type:
string
One of [KPI, PREDICTION, ANOMALY, SENSOR].
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 : params
Type:
object
Additional Properties Allowed
Show Source
-
string
A map of the following type: Map<String, String>
Property description was not set
Show Source
Nested Schema : items
Type:
Show Source
object
-
href:
string
The target resource URIExample:
https://iotserver/iot/api/vX/some/API/path
-
rel:
string
Relation typeExample:
canonical
401 Response
Unauthorized. The request requires user authentication.
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/drivers
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"items": [
{
"id": "5432EFA4-96E4-4332-80AF-82BBB995EA52",
"name": "Driver4",
"loginId": "Driver4",
"dutyStatus": "DRIVING",
"tripId": "DE75FFB0-4193-44D3-B8A5-C726DCD791EC",
"vehicleId": "D2B7B78A-653C-4F6C-9CB5-1D901BADA5FF",
"registrationTime": 1519032343175,
"registrationTimeAsString": "2018-02-19T09:25:43.175Z",
"registeredBy": "system",
"lastModifiedTime": 1519032343175,
"lastModifiedTimeAsString": "2018-02-19T09:25:43.175Z",
"lastModifiedBy": "system",
"links": [
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/vehicles/D2B7B78A-653C-4F6C-9CB5-1D901BADA5FF",
"rel": "vehicle"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/trips/DE75FFB0-4193-44D3-B8A5-C726DCD791EC",
"rel": "trip"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers/5432EFA4-96E4-4332-80AF-82BBB995EA52/metrics",
"rel": "metrics"
}
]
}
],
"links": [
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers?offset=0&limit=10&q=%7B%20%22$and%22%20:%20[%7B%20%22$or%22%20:%20[%7B%22registeredBy%22:%20%7B%20%22$exists%22:false%20%7D%20%7D,%7B%22registeredBy%22:%20%7B%20%22$ne%22:%22OIOTFMSYS%22%20%7D%20%7D]%20%7D,%7B%22loginId%22:%20%7B%20%22$eq%22:%22Driver4%22%20%7D%20%7D]%20%7D",
"rel": "self"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers",
"rel": "canonical"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers?q=%7B%20%22$and%22%20:%20[%7B%20%22$or%22%20:%20[%7B%22registeredBy%22:%20%7B%20%22$exists%22:false%20%7D%20%7D,%7B%22registeredBy%22:%20%7B%20%22$ne%22:%22OIOTFMSYS%22%20%7D%20%7D]%20%7D,%7B%22loginId%22:%20%7B%20%22$eq%22:%22Driver4%22%20%7D%20%7D]%20%7D&offset=0&limit=10",
"rel": "first"
},
{
"href": "https://iotserver/fleetMonitoring/clientapi/v2/drivers?q=%7B%20%22$and%22%20:%20[%7B%20%22$or%22%20:%20[%7B%22registeredBy%22:%20%7B%20%22$exists%22:false%20%7D%20%7D,%7B%22registeredBy%22:%20%7B%20%22$ne%22:%22OIOTFMSYS%22%20%7D%20%7D]%20%7D,%7B%22loginId%22:%20%7B%20%22$eq%22:%22Driver4%22%20%7D%20%7D]%20%7D&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/drivers
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.