VOvolteras
Vehicle Command Executions

Get Vehicle Command Execution

Changed on

Retrieve detailed information about a vehicle command execution by specifying its unique identifier (ID).

Parameters:

  • vehicle_id: The unique identifier (ID) of the vehicle.
  • vehicle_command_execution_id: The unique identifier (ID) of the vehicle command execution.

Returns:

  • A response containing detailed information about the vehicle command execution.

Possible Codes in Error Response (see Errors for error response schema and meaning of codes):

  • AUTHENTICATION_ERROR
  • REQUEST_VALIDATION_ERROR
  • RESOURCE_NOT_FOUND
  • SERVER_ERROR
get/v1/vehicles/{vehicle_id}/command-executions/{vehicle_command_execution_id}

Request

Path parameters

vehicle_command_execution_idstring required

ID of the vehicle command execution.

vehicle_idstring required

Unique internal identifier for the vehicle.

Response

Successful Response

idstring nullable
commandArgumentsobject nullable
timeoutinteger nullable
executedAtstring date-time nullable

When the command was accepted and sent to the OEM. Command outcome arrives later through status.

status'PENDING' | 'EXECUTED' | 'FAILED'

Enum for command execution status.

failedReason'OEM_UNKNOWN_ERROR' | 'OEM_TIMEOUT' | 'OEM_UNAVAILABLE' | 'OEM_NETWORK_ERROR' | 'OEM_INCORRECT_REGION' | 'OEM_APP_REQUIRED_UPDATE' | 'OEM_USER_ACCOUNT_LOCKED' | 'OEM_OAUTH_TOKEN_EXPIRED' | 'OEM_VEHICLE_OFFLINE' | 'OEM_VEHICLE_REMOTE_ACCESS_DISABLED' | 'OEM_VEHICLE_LOCATION_SHARING_DISABLED' | 'OEM_AUTH_DRIVER_IS_NOT_PRIMARY_USER' | 'OEM_DEVICE_NOT_FOUND' | 'OEM_COMMAND_TIMEOUT' | 'OEM_COMMAND_FAILED' | 'OEM_COMMAND_SUCCEEDED_WITH_DOOR_AJAR' | 'OEM_RATE_LIMITED' | 'OEM_ACCOUNT_RATE_LIMITED' | 'OEM_DEVICE_RATE_LIMITED' | 'OEM_STOP_CHARGE_RATE_LIMITED' | 'OEM_COMMANDS_RATE_LIMITED' | 'OEM_VEHICLE_LOCATION_UNKNOWN' | 'OEM_VEHICLE_NOT_IN_AUTHORIZED_LOCATION' | 'OEM_VEHICLE_CHARGING_NOT_FINISHED' | 'OEM_VEHICLE_CHARGING_NOT_STOPPED' | 'OEM_VEHICLE_CHARGING_NOT_STARTED' | 'OEM_VEHICLE_CHARGING_NOT_PAUSED' | 'OEM_VEHICLE_CHARGING_REFUSED_PLAY_PROTECTION' | 'OEM_COMMAND_REFUSED_OTHER_SERVICE_RUNNING' | 'OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_STAND_STILL_AND_RESTING_STATE' | 'OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_STAND_STILL_AND_ACTIVE_STATE' | 'OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_DRIVING_OR_READY_TO_DRIVE' | 'OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_DIAGNOSTICS_MODE' | 'SERVER_ERROR' | 'INTERNAL_RATE_LIMITED' | 'AUTHENTICATION_ERROR' | 'NOT_PERMITTED' nullable

The reason the command failed to execute. Should be one of the codes listed in the enum, but may in some cases be a plain string.

vehicleIdstring required
command'WAKE_UP' | 'UNLOCK_DOORS' | 'LOCK_DOORS' | 'HONK_HORN' | 'FLASH_LIGHTS' | 'START_HVAC_SYSTEM' | 'CLIMATE_ON' | 'CLIMATE_OFF' | 'SET_TEMPERATURE' | 'SET_CHARGE_LIMIT' | 'ACTUATE_FRONT_TRUNK' | 'ACTUATE_REAR_TRUNK' | 'OPEN_CHARGE_PORT' | 'CLOSE_CHARGE_PORT' | 'START_CHARGING' | 'STOP_CHARGING' | 'SET_VEHICLE_NAME' | 'SCHEDULE_SOFTWARE_UPDATE' | 'CANCEL_SOFTWARE_UPDATE' | 'WINDOW_HEATING_ON' | 'WINDOW_HEATING_OFF' required

Enum for available commands.

Changes

  • 078c16437669Revision changes
    • warning

      added the new OEM_COMMAND_SUCCEEDED_WITH_DOOR_AJAR enum value to the response property for the response status