Returns a paginated list of vehicles associated with a provider that match the request options.
HTTP request
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Must be in the format |
Query parameters
Parameters | |
---|---|
header |
The standard Fleet Engine request header. |
pageSize |
The maximum number of vehicles to return. Default value: 100. |
pageToken |
The value of the |
minimumCapacity |
Specifies the required minimum capacity of the vehicle. All vehicles returned will have a |
tripTypes[] |
Restricts the response to vehicles that support at least one of the specified trip types. |
maximumStaleness |
Restricts the response to vehicles that have updated their locations within the specified duration at the time of the call. If present, must be a valid positive duration. A duration in seconds with up to nine fractional digits, ending with ' |
vehicleTypeCategories[] |
Required. Restricts the response to vehicles with one of the specified type categories. |
requiredAttributes[] |
Callers can form complex logical operations using any combination of the
Restricts the response to vehicles with the specified attributes. This field is a conjunction/AND operation. Your app can specify up to 100 attributes; however, the combined key:value string length cannot exceed 1024 characters. |
requiredOneOfAttributes[] |
Restricts the response to vehicles with at least one of the specified attributes in each |
requiredOneOfAttributeSets[] |
Similar to
Restricts the response to vehicles that match all the attributes in a |
vehicleState |
Restricts the response to vehicles that have this vehicle state. |
onTripOnly |
Only return the vehicles with current trip(s). |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
vehicles.list
response message.
JSON representation |
---|
{
"vehicles": [
{
object ( |
Fields | |
---|---|
vehicles[] |
Vehicles matching the criteria in the request. The maximum number of vehicles returned is determined by the |
nextPageToken |
Token to retrieve the next page of vehicles, or empty if there are no more vehicles that meet the request criteria. |
totalSize |
Required. Total number of vehicles matching the request criteria across all pages. |