POST
/
v1.0.0
/
users
/
{userId}
/
vehicles
/
{vehicleId}
/
commands
/
{command}

Authorizations

X-API-KEY
string
headerrequired

ApiKey used for authorization and authentication

Path Parameters

userId
string
required

User ID

vehicleId
string
required

Vehicle ID

command
enum<string>
required

Name of the command to execute

Available options:
CHARGING_START,
CHARGING_STOP

Response

200 - application/json
createdAt
string
required

The timestamp when command is created.

id
string
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 for vehicle to execute.

  • CHARGING_START - Command to start the charging of a vehicle
  • CHARGING_STOP - Command to stop the charging of a vehicle
Available options:
CHARGING_START,
CHARGING_STOP
userId
string
required

The ID of the user.

deviceId
string
required

The ID of the vehicle.

Vehicle image for userAll vehicles for user