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"
}

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Error",
  "detail": "Command timeout.",
  "updated": "2023-02-14 09:53:48"
}

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Pending",
  "detail": {},
  "updated": "2023-02-14 09:51:48"
}

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"
}

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Error",
  "detail": "Command timeout.",
  "updated": "2023-02-14 09:53:48"
}

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Pending",
  "detail": {},
  "updated": "2023-02-14 09:51:48"
}

Use esta rota para verificar o status de um comando que foi iniciado através da rota POST /vehicle-command.

Request

Header

string

obrigatório

É o token ao portador utilizado para autenticar a empresa.

Path Parameters

string

obrigatório

O identificador único (UUID) do comando, retornado na resposta da requisição POST /vehicle-command.

Response

string

Indica o identificador único (UUID) do comando registrado no sistema da mobway.

string

Indica o número de identificação único do veículo.

string

Indica o comando que foi solicitado.

string

Indica o status atual do comando. Pode ser “Pending”, em que o comando ainda não foi processado, “Success”, quando o comando foi executado corretamente, ou “Error”, quando o comando não foi executado corretamente.

json object or string

Indica detalhes adicionais sobre o resultado do comando. Em caso de sucesso, pode conter um objeto com informações retornadas pelo veículo. Em caso de erro, geralmente contém um texto com a descrição do erro, conforme a descrição abaixo. Será um objeto vazio enquanto o comando ainda estiver “Pending” ou quando o comando não retornar nenhuma informação adicional.

Erros na Requisição. Ocorrem quando há um problema entre o cliente o servidor da mobway, por exemplo uma requisição mal formada ou com acesso negado.
- “Invalid command ID. Command ID must be a string. At least one command ID is required.”: A requisição está mal formada pela falta do parâmetro obrigatório command_id.
- “Command not found.”: O command_id fornecido não corresponde a nenhum comando registrado.
- “Access denied.”: O comando solicitado pertence a uma aplicação diferente daquela associada ao token de autenticação utilizado.
Erros no Comando. Ocorrem quando há um problema entre o servidor da mobway e da montadora ou entre a montadora e o veículo, por exemplo quando o comando não consegue ser executado por estar fora da área de cobertura do sinal.
- “Command timeout.”: A requisição não conseguiu ser executada no tempo pré-determinado ou não obteve a resposta esperada do veículo.
- “Commands blocked.”: Comando recusado porque o veículo está em estado incompatível (ex: em movimento) ou não possui capacidade para processá-lo.
- “Commands restrictions.”: Comando não conseguiu ser executado completamente (ex: geolocalização do veículo está oculta por privacidade).
- “Communication failures.”: Conexão interrompida ou instável entre a rede e o veículo, impedindo troca de dados (ex: sinal fraco, falha de protocolo).
- “Data retrieval failures.”: Dados recebidos estão parcialmente disponíveis ou não foram coletados devido a erros de transmissão.
- “Internal system failures.”: Serviço fora do ar temporariamente ou erro crítico em processos internos.
- “Invalid input.”: Comando enviado inclui informações inválidas, incompletas ou opções não reconhecidas.
- “Unauthorized access.”: Sessão expirada ou tentativa de acesso a recursos restritos sem privilégios adequados.
- “Unsupported commands.”: Funcionalidade indisponível para o modelo ou falta de autorização para ação.

datetime

Indica a data e hora da última atualização do status do comando no sistema da mobway [YYYY-MM-DD HH:MM:SS] (UTC-3). Se o valor for igual ao created em POST /vehicle-command, quer dizer que o comando ainda não teve nenhuma atualização no sistema da mobway.

Os três valores de data e hora por comando são:

created: quando o comando foi registrado no sistema da mobway (POST /vehicle-command)
date_time: quando o comando foi executado pelo veículo
updated: quando a mobway recebeu a resposta do comando

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"
}

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Error",
  "detail": "Command timeout.",
  "updated": "2023-02-14 09:53:48"
}

{
  "id": "8619b2df-1d68-40e1-8760-cf36f06d00b5",
  "vin": "6AHFT68CKAF501652",
  "command": "diagnostics",
  "status": "Pending",
  "detail": {},
  "updated": "2023-02-14 09:51:48"
}

POST vehicle-command

Geral

Endpoint

GET vehicle-command/{command_id}

Request

Header

Path Parameters

Response

​Request

Header

Path Parameters

​Response

Request

Response