Gets all DeliveryVehicle
s that meet the specified filtering criteria.
HTTP request
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Must be in the format |
Query parameters
Parameters | |
---|---|
header |
Optional. The standard Delivery API request header. |
page |
Optional. The maximum number of vehicles to return. The service may return fewer than this number. If you don't specify this number, then the server determines the number of results to return. |
page |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
filter |
Optional. A filter query to apply when listing delivery vehicles. See http://aip.dev/160 for examples of the filter syntax. If you don't specify a value, or if you specify an empty string for the filter, then all delivery vehicles are returned. Note that the only queries supported for The maximum number of restrictions allowed in a filter query is 50. A restriction is a part of the query of the form |
viewport |
Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport. |
Request body
The request body must be empty.
Response body
The deliveryVehicles.list
response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"deliveryVehicles": [
{
object ( |
Fields | |
---|---|
delivery |
The set of delivery vehicles that meet the requested filtering criteria. When no filter is specified, the request returns all delivery vehicles. A successful response can also be empty. An empty response indicates that no delivery vehicles were found meeting the requested filter criteria. |
next |
You can pass this token in the |
total |
The total number of delivery vehicles that match the request criteria, across all pages. |
Viewport
A latitude-longitude viewport, represented as two diagonally opposite low
and high
points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:
If
low
=high
, the viewport consists of that single point.If
low.longitude
>high.longitude
, the longitude range is inverted (the viewport crosses the 180 degree longitude line).If
low.longitude
= -180 degrees andhigh.longitude
= 180 degrees, the viewport includes all longitudes.If
low.longitude
= 180 degrees andhigh.longitude
= -180 degrees, the longitude range is empty.If
low.latitude
>high.latitude
, the latitude range is empty.
Both low
and high
must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.
For example, this viewport fully encloses New York City:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
JSON representation |
---|
{ "low": { object ( |
Fields | |
---|---|
low |
Required. The low point of the viewport. |
high |
Required. The high point of the viewport. |