POST
/
v1.0.0
/
vehicles
/
{vehicleId}
/
commands
/
charging-schedule
Submit command for vehicle charging schedule
curl --request POST \
  --url https://api.energy-hub.io/v1.0.0/vehicles/{vehicleId}/commands/charging-schedule \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "schedules": [
    {
      "type": "CHARGE",
      "stateOfChargeTarget": 80,
      "location": {
        "latitude": 50.770774,
        "longitude": -126.104965
      },
      "chargeRateMax": 12,
      "days": [
        "MONDAY"
      ],
      "start": "12:00",
      "end": "18:00"
    }
  ]
}'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "PENDING",
  "type": "CHARGING_START",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Charging Schedules are only supported for BMW, MINI and Tesla vehicles.

Authorizations

​
X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

​
vehicleId
string<uuid>
required

Vehicle ID

Body

application/json

New schedule be to set. UTC expected.

​
schedules
object[]
required

The list of schedule events.

Response

Successful operation

​
createdAt
string<date-time>
required

The timestamp when command is created.

​
id
string<uuid>
required

The ID of the command.

​
state
enum<string>
required

The state of the command.

  • PENDING - Command is waiting to be executed.
  • FAILED - Execution of command has failed.
  • EXECUTED - Command has been executed successfully.
Available options:
PENDING,
EXECUTED,
FAILED
​
type
enum<string>
required

The name of the command type to execute.

Available options:
CHARGING_START,
CHARGING_STOP
​
userId
string
required

The ID of the user.

Example:

"896f9d5a-b618-48a2-98ae-957059bf1bc9"

​
deviceId
string<uuid>
required

The ID of the vehicle.