Skip to main content
GET
/
vehicle-command
/
{command_id}
curl --request GET \
  --url https://api.mobway.cloud/vehicle-command/{command_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Success",
  "detail": {
    "fuel_amount": 43.47,
    "fuel_capacity": 44.0,
    "fuel_level": 98.8,
    "fuel_range": 542.37,
    "ideal_front_tire_pressure": 34.81,
    "ideal_rear_tire_pressure": 34.81,
    "left_front_tire_pressure": 33.07,
    "left_front_tire_pressure_status": "nominal",
    "left_rear_tire_pressure": 31.91,
    "left_rear_tire_pressure_status": "nominal",
    "odometer": 76140.81,
    "oil_remaining_life": 53.3,
    "oil_remaining_life_status": "normal",
    "right_front_tire_pressure": 31.91,
    "right_front_tire_pressure_status": "nominal",
    "right_rear_tire_pressure": 31.33,
    "right_rear_tire_pressure_status": "nominal",
    "seat_belt_status": "not buckled",
    "system_power_mode": "off",
    "total_fuel_economy": 12.32,
    "total_fuel_used": 6766.5,
    "date_time": "2023-02-14 09:52:48"
  },
  "updated": "2023-02-14 09:53:48"
}
Use this route to check the status of a command that was initiated through the POST /vehicle-command route.

​
Request

Header
​
Authorization
string
required
The bearer token used to authenticate the company.
Path Parameters
​
command_id
string
required
The unique command identifier (UUID), returned in the response from the POST /vehicle-command request.

​
Response

​
id
string
The unique identifier (UUID) of the command registered in the mobway system.
​
vin
string
The vehicle’s unique identification number.
​
command
string
The command that was requested.
​
status
string
The current status of the command. It can be “Pending”, when the command has not yet been processed, “Success”, when the command was executed successfully, or “Error”, when the command was not executed successfully.
​
detail
json object or string
Additional details about the command result. In case of success, it may contain an object with information returned by the vehicle. In case of error, it usually contains text describing the error, as described below. It will be an empty object while the command is still “Pending” or when the command does not return any additional information.
  • Request errors. These occur when there is an issue between the client and the mobway server, such as a malformed request or denied access.
    • “Invalid command ID. Command ID must be a string. At least one command ID is required.”: The request is malformed because the required command_id parameter is missing.
    • “Command not found.”: The provided command_id does not match any registered command.
    • “Access denied.”: The requested command belongs to a different application than the one associated with the authentication token being used.
  • Command errors. These occur when there is an issue between the mobway server and the automaker, or between the automaker and the vehicle, such as when the command cannot be executed because the vehicle is outside signal coverage.
    • “Command timeout.”: The request could not be executed within the predefined time or did not receive the expected response from the vehicle.
    • “Commands blocked.”: The command was rejected because the vehicle is in an incompatible state (for example, moving) or does not have the capability to process it.
    • “Commands restrictions.”: The command could not be fully executed (for example, the vehicle’s geolocation is hidden for privacy reasons).
    • “Communication failures.”: The connection between the network and the vehicle was interrupted or unstable, preventing data exchange (for example, weak signal or protocol failure).
    • “Data retrieval failures.”: The received data is only partially available or was not collected due to transmission errors.
    • “Internal system failures.”: The service is temporarily unavailable or there was a critical error in internal processes.
    • “Invalid input.”: The submitted command includes invalid or incomplete information, or unrecognized options.
    • “Unauthorized access.”: The session has expired or there was an attempt to access restricted resources without the required privileges.
    • “Unsupported commands.”: The feature is unavailable for the model or the action is not authorized.
​
updated
datetime
The date and time of the latest command status update in the mobway system [YYYY-MM-DD HH:MM:SS] (UTC-3). If the value is equal to created in POST /vehicle-command, it means the command has not yet been updated in the mobway system.
The three date and time values for each command are:
  • created: when the command was registered in the mobway system (POST /vehicle-command)
  • date_time: when the command was executed by the vehicle
  • updated: when mobway received the command response
curl --request GET \
  --url https://api.mobway.cloud/vehicle-command/{command_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Success",
  "detail": {
    "fuel_amount": 43.47,
    "fuel_capacity": 44.0,
    "fuel_level": 98.8,
    "fuel_range": 542.37,
    "ideal_front_tire_pressure": 34.81,
    "ideal_rear_tire_pressure": 34.81,
    "left_front_tire_pressure": 33.07,
    "left_front_tire_pressure_status": "nominal",
    "left_rear_tire_pressure": 31.91,
    "left_rear_tire_pressure_status": "nominal",
    "odometer": 76140.81,
    "oil_remaining_life": 53.3,
    "oil_remaining_life_status": "normal",
    "right_front_tire_pressure": 31.91,
    "right_front_tire_pressure_status": "nominal",
    "right_rear_tire_pressure": 31.33,
    "right_rear_tire_pressure_status": "nominal",
    "seat_belt_status": "not buckled",
    "system_power_mode": "off",
    "total_fuel_economy": 12.32,
    "total_fuel_used": 6766.5,
    "date_time": "2023-02-14 09:52:48"
  },
  "updated": "2023-02-14 09:53:48"
}