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.

Response

Supported Media Types

• application/json

200 Response

Successfully processed.

Body ()

Root Schema : DriverImpl_receive

Type: object

Show Source

• 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
• metrics: object DriverMetrics_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

{
    "type":"object",
    "required":[
        "id",
        "name",
        "loginId",
        "mobileNumber",
        "dutyStatus",
        "tripId",
        "vehicleId",
        "metrics",
        "registrationTime",
        "registrationTimeAsString",
        "registeredBy",
        "lastModifiedTime",
        "lastModifiedTimeAsString",
        "lastModifiedBy"
    ],
    "properties":{
        "registrationTime":{
            "description":"Registration time of the driver (millisecond)",
            "type":"integer"
        },
        "loginId":{
            "description":"Driver's Login ID",
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"Time when driver was last modified (millisecond)",
            "type":"integer"
        },
        "registeredBy":{
            "description":"Driver registered by",
            "type":"string"
        },
        "mobileNumber":{
            "description":"Driver mobile number",
            "type":"string"
        },
        "lastModifiedBy":{
            "description":"Driver last modified by",
            "type":"string"
        },
        "lastModifiedTimeAsString":{
            "description":"Time when driver was last modified, as String",
            "type":"string"
        },
        "tripId":{
            "description":"ID of the trip corresponding to the driver",
            "type":"string"
        },
        "dutyStatus":{
            "description":"DutyStatus one of [OFF_DUTY, DRIVING, SLEEPER_BERTH, ON_DUTY_NOT_DRIVING]One of [OFF_DUTY, DRIVING, SLEEPER_BERTH, ON_DUTY_NOT_DRIVING].",
            "type":"string"
        },
        "registrationTimeAsString":{
            "description":"Registration time of the driver, as String",
            "type":"string"
        },
        "name":{
            "description":"Driver name",
            "type":"string"
        },
        "id":{
            "description":"Driver ID",
            "type":"string"
        },
        "vehicleId":{
            "description":"ID of the vehicle assigned to the driver",
            "type":"string"
        },
        "metrics":{
            "$ref":"#/definitions/DriverMetrics_receive"
        }
    }
}

Nested Schema : DriverMetrics_receive

Type: object

Show Source

• alertCount: integer
  Property description was not set
• distanceDriven: number
  Property description was not set
• fenceViolationCount: integer
  Property description was not set
• idlingDuration: integer
  Property description was not set
• idlingDurationViolationCount: integer
  Property description was not set
• incidentCount: integer
  Property description was not set
• speedViolationCount: integer
  Property description was not set
• unauthorizedStopsCount: integer
  Property description was not set

{
    "type":"object",
    "required":[
        "incidentCount",
        "idlingDuration",
        "distanceDriven",
        "alertCount",
        "idlingDurationViolationCount",
        "speedViolationCount",
        "fenceViolationCount",
        "unauthorizedStopsCount"
    ],
    "properties":{
        "speedViolationCount":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "fenceViolationCount":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "incidentCount":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "alertCount":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "distanceDriven":{
            "description":"Property description was not set",
            "type":"number"
        },
        "unauthorizedStopsCount":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "idlingDuration":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "idlingDurationViolationCount":{
            "description":"Property description was not set",
            "type":"integer"
        }
    }
}

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/drivers/{id} 

Example of Response Body

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

{
    "registrationTime":1469184297746,
    "loginId":"76cf7e367315-5365",
    "lastModifiedTime":1469184297746,
    "registeredBy":"Driver registered by",
    "mobileNumber":"Driver mobile number",
    "lastModifiedBy":"Driver last modified by",
    "lastModifiedTimeAsString":"2016-07-22T10:44:57.746Z",
    "tripId":"709013ad3790-5696",
    "dutyStatus":"OFF_DUTY",
    "registrationTimeAsString":"2016-07-22T10:44:57.746Z",
    "name":"Driver name",
    "id":"6a9c69e71fa8-378a",
    "vehicleId":"51a4c576cc8-4f4b",
    "metrics":{
        "speedViolationCount":12345,
        "fenceViolationCount":12345,
        "incidentCount":12345,
        "alertCount":12345,
        "distanceDriven":0.0,
        "unauthorizedStopsCount":12345,
        "idlingDuration":12345,
        "idlingDurationViolationCount":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/drivers/11ba550771c9-4a84 

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.