Page Summary
-
Makes a vehicle available for use, potentially specifying future availability start times.
-
Uses a POST request to the specified URL with parameters for network and vehicle identification.
-
Requires a request body which can optionally include future availability start periods.
-
If successful, the response provides the vehicle's name and updated paths.
-
Leverages gRPC Transcoding for communication.
Makes a vehicle available.
HTTP request
POST https://middlemileoptimization.googleapis.com/v1/{name=networks/*/vehicles/*}:makeAvailable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
Required. The name of the vehicle to make available. Format: "networks/{network}/vehicle/{vehicle}" |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{
"availabilityStarts": [
{
object ( |
| Fields | |
|---|---|
availability |
Required. The periods where availability will start. They must be points in time in the future. If this field is absent, availability starts when the message is received. |
Response body
The response message for vehicles.makeAvailable method.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"name": string,
"path": [
{
object ( |
| Fields | |
|---|---|
name |
The name of the vehicle whose availability was updated. Format: "networks/{network}/vehicles/{vehicle}" |
path[] |
The paths that were updated. |