Retrieve driver by ID
get
/fleetMonitoring/clientapi/v2/drivers/{id}
This operation returns information about a driver that is specified by its ID.
Request
Path Parameters
-
id: string
Driver ID
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.
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
200 Response
Successfully processed.
Root Schema : Driver_receive
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 (epoch time in milliseconds)
-
lastModifiedTimeAsString:
string
Time when driver was last modified, as String
-
loginId:
string
Driver's Login ID
-
metricSnapshot:
object MetricSnapshot_receive
-
mobileNumber:
string
Driver mobile number
-
name:
string
Driver name
-
registeredBy:
string
Driver registered by
-
registrationTime:
integer
Registration time of the driver (epoch time in milliseconds)
-
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 : MetricSnapshot_receive
Type:
Show Source
object
-
metricValues:
array metricValues
The metric values of an entity
Nested Schema : MetricValue_receive
Type:
Show Source
object
-
booleanValue(optional):
boolean
Property description was not set
-
computedTime:
integer
Property description was not set
-
confidenceLevel(optional):
integer
Property description was not set
-
entityId:
string
Property description was not set
-
entityType:
string
Property description was not set
-
esAdditionalData:
object esAdditionalData
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
esRelationType:
object EsJoinFieldValue_receive
-
eventTime:
integer
Property description was not set
-
eventTimeAsString:
string
Property description was not set
-
geoLocationValue(optional):
object GeoPosition_receive
-
id:
string
Property description was not set
-
interval:
string
One of [DYNAMIC, CURRENT, EVERY2MINUTE, HOURLY, DAILY, NEXT24HOURS, WEEKLY, BIWEEKLY, NEXT7DAYS, NEXT30DAYS, MONTHLY, DAYS90, STATIC].
-
lastKnown:
boolean
Property description was not set
-
metadata:
object metadata
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
name:
string
Property description was not set
-
numericValue(optional):
integer
Property description was not set
-
params:
object params
Additional Properties Allowed: additionalPropertiesProperty description was not set
-
stringValue(optional):
string
Property description was not set
-
type:
string
One of [KPI, PREDICTION, ANOMALY, TREND_NELSON, TREND, SENSOR, CORRELATION, CLUSTERING].
Nested Schema : esAdditionalData
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 : EsJoinFieldValue_receive
Type:
Show Source
object
-
name:
string
Property description was not set
-
parent:
string
Property description was not set
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 : metadata
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 : 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
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.
Examples
curl -X GET
-u <username>:<password>
-H 'Accept: application/json'
https://iotserver/fleetMonitoring/clientapi/v2/drivers/{id}
Example of Response Body
The following example shows the content of the response body in JSON format:
{
"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:443/fleetMonitoring/clientapi/v2/drivers/5432EFA4-96E4-4332-80AF-82BBB995EA52/",
"rel": "self"
},
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/drivers/5432EFA4-96E4-4332-80AF-82BBB995EA52/",
"rel": "canonical"
},
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/vehicles/D2B7B78A-653C-4F6C-9CB5-1D901BADA5FF",
"rel": "vehicle"
},
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/trips/DE75FFB0-4193-44D3-B8A5-C726DCD791EC",
"rel": "trip"
},
{
"href": "https://iotserver:443/fleetMonitoring/clientapi/v2/drivers/5432EFA4-96E4-4332-80AF-82BBB995EA52/metrics",
"rel": "metrics"
}
]
}
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/43961a0f489e-77b
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.