Retrieve a list of vehicles

SecuritybearerAuth

Request

query Parameters

GroupId	string or null <guid> ID of the group that the vehicle of interest is associated to (GUID).
PageNumber	integer <int32> >= 1 Default: 1 The page number of the list of vehicles. Default value is 1.
PageSize	integer <int32> [ 1 .. 2147483647 ] The number of vehicles to return per page. Default value is 50.
VehicleName	string or null [ 1 .. 50 ] characters An identifier to filter by a vehicle's name. This parameter allows for matching all or any part of a vehicle name. If more than one vehicle matches the name pattern, a list of them will be returned. Pattern is considered as match either partially or fully (i.e. pattern=“ABC”, matches: ABC, myABCvehicle, ABCfleet, fleetABC etc.)

Responses

200

400

The parameters given in the request are invalid.

401

Access is denied. This can occur from an invalid key or invalid pod.

403

You have no permissions to make this operation.

500

Requested operation cannot be performed.

503

Requested operation cannot be performed. Try again later.

get/vehicles

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"totalCount": 0,
"vehicles": [{"id": 0,
"groupId": "string",
"name": "string",
"status": 0,
"lastCommunication": "2019-08-24T14:15:22Z",
"devices": [{"id": 0,
"serialNumber": "string",
"lastCommunication": "2019-08-24T14:15:22Z",
"onlineStatus": 0,
"views": [{"id": 0,
"name": "string",
"label": "string"
}
],
"roleId": 0
}
]
}
]
}