1. REST API for Oracle IoT Fleet Monitoring Cloud Service
  2. Tasks
  3. Vehicle Management

List vehicles

get

/fleetMonitoring/clientapi/v2/vehicles

This operation returns the list of all vehicles.

Request

Query Parameters

Response

Supported Media Types

200 Response

Successfully processed.
Body ()
Root Schema : VehicleImpl_receive_list
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : devices
Type: object
Additional Properties Allowed
Show Source
  • A map of the following type: Map<String, String>
List of vehicle parameters available e.g On Board Diagnostics 2 (OBD2).
Show Source
Nested Schema : GeoPosition_receive
Type: object
Show Source
Nested Schema : additionalElements
Type: array
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

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/vehicles

Example of Response Body

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


{
    "offset":0,
    "count":2,
    "limit":10,
    "hasMore":false,
    "links":[
        {
            "rel":"self",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        },
        {
            "rel":"canonical",
            "href":"https://iotserver/fleetMonitoring/clientapi/version/resource/path"
        }
    ],
    "items":[
        {
            "utilizationStatus":false,
            "registrationTime":1469184297746,
            "lastReportedTime":1469184297746,
            "lastModifiedTime":1469184297746,
            "registeredBy":"vehicle registered by",
            "vehicleIdlingDuration":12345,
            "year":12345,
            "openOutageIncidents":12345,
            "tripId":"26073b742563-3be7",
            "openIncidents":12345,
            "fuelConsumed":12345,
            "averageFuelEconomy":12345,
            "model":"vehicle model",
            "vin":"vehicle identification number",
            "availabilityStatus":false,
            "consumedFuelCost":12345,
            "id":"20ff46e437e5-2d1d",
            "make":"vehicle make",
            "devices":{
                "devices_key1":"devices_value1",
                "devices_key2":"devices_value2",
                "devices_key3":"devices_value3"
            },
            "lastModifiedBy":"vehicle modified by",
            "registrationTimeAsString":"2016-07-22T10:44:57.746Z",
            "driverId":"4ac46545109d-2467",
            "geoLocation":[longitude,latitude],
            "registrationNumber":"vehicle registration number",
            "name":"vehicle Name",
            "status":"vehicle mobility status, One of [IN_MOTION, STOPPED, UNKNOWN]."
        },
        {
            "utilizationStatus":false,
            "registrationTime":1469184297746,
            "lastReportedTime":1469184297746,
            "lastModifiedTime":1469184297746,
            "registeredBy":"vehicle registered by",
            "vehicleIdlingDuration":12345,
            "year":12345,
            "openOutageIncidents":12345,
            "tripId":"43d4f1a7185-543f",
            "openIncidents":12345,
            "fuelConsumed":12345,
            "averageFuelEconomy":12345,
            "model":"vehicle model",
            "vin":"vehicle identification number",
            "availabilityStatus":false,
            "consumedFuelCost":12345,
            "id":"4e4a4ed07bc8-37b8",
            "make":"vehicle make",
            "devices":{
                "devices_key1":"devices_value1",
                "devices_key2":"devices_value2",
                "devices_key3":"devices_value3"
            },
            "lastModifiedBy":"vehicle modified by",
            "registrationTimeAsString":"2016-07-22T10:44:57.746Z",
            "driverId":"19681b4f2ade-6e97",
            "geoLocation":[longitude,latitude],
            "registrationNumber":"vehicle registration number",
            "name":"vehicle Name",
            "status":"vehicle mobility status, One of [IN_MOTION, STOPPED, UNKNOWN]."
        }
    ]
}



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/vehicles



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.