POST
/
vehicle-data
Apesar de ser uma requisição POST, está rota não se destina a criar um recurso na API. Foi desenvolvida desta forma pela comodidade de customizar o payload a ser enviado no corpo da requisição.

Request

Header
token
string
required

É o token ao portador utilizado para autenticar a empresa.

Body
vins
list of strings
required

Indica a lista de Vehicle Identification Number (VIN) dos veículos os quais se deseja recuperar os dados.

datapoints
list of strings
required

Indica a lista de pontos de dados que se deseja recuperar dos veículos. As opções são:

  • date_time: Data e Hora [YYYY-MM-DDTHH:MM:SS]
  • speed: Velocidade [km/h]
  • latitude: Latitude [°]
  • longitude: Longitude [°]
  • heading: Orientação [°]
  • rpm: Rotações por Minuto [RPM]
  • odometer: Odômetro [km]
  • fuel_level: Nível de Combustível [L]
  • range: Autonomia [km]
  • tire_pressure_front_left: Pressão do Pneu Dianteiro Esquerdo [psi]
  • tire_pressure_front_right: Pressão do Pneu Dianteiro Direito [psi]
  • tire_pressure_rear_left: Pressão do Pneu Traseiro Esquerdo [psi]
  • tire_pressure_rear_right: Pressão do Pneu Traseiro Direito [psi]
  • oil_level: Nível do Óleo [%]
  • engine_cooling_temperature: Temperatura do Líquido de Arrefecimento do Motor [°C]
  • lv_battery_voltage: Tensão da Bateria de Baixa Tensão [V]
  • hv_battery_voltage: Tensão da Bateria de Alta Tensão [V]
  • hv_battery_soc: Estado de Carga da Bateria de Alta Tensão [%]
  • hv_battery_charging_status: Estado de Carregamento da Bateria de Alta Tensão
  • seat_belt_status: Estado do Cinto de Segurança
  • event: Eventos
  • flag: Flags
start_date
date or datetime

É um parâmetro opcional e pode ser usado para filtrar a data de início dos dados. Deve ser enviado nos seguintes formatos: YYYY-MM-DD ou YYYY-MM-DDTHH:MM:SS (ISO 8601). Caso o formato escolhido seja YYYY-MM-DD, para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDT00:00:00

end_date
date or datetime

Também é um parâmetro opcional para filtrar a data de fim dos dados. Segue os mesmos formatos: YYYY-MM-DD ou YYYY-MM-DDTHH:MM:SS (ISO 8601). Caso o formato escolhido seja YYYY-MM-DD, para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDT23:59:59

Quando forem utilizados start_date e end_date, o date_time estará entre estas duas datas, da seguinte forma: end_data >= datetime >= start_date

Response

Para informações mais detalhadas sobre a resposta, consultar em Pontos de Dados
vin
string

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

date_time
datatime

Indica a data e hora do registro do conjunto de dados [YYYY-MM-DDTHH:MM:SS].

speed
number

Indica a velocidade [km/h].

latitude
number

Indica a latitude [°].

longitude
number

Indica a longitude [°].

heading
number

Indica a orientação [°].

rpm
number

Indica as rotações por minuto [RPM].

odometer
number

Indica o odômetro [km].

fuel_level
number

Indica o nível de combustível [L].

range
number

Indica a autonomia [km].

tire_pressure_front_left
number

Indica a pressão do pneu dianteiro esquerdo [psi].

tire_pressure_front_right
number

Indica a pressão do pneu dianteiro direito [psi].

tire_pressure_rear_left
number

Indica a pressão do pneu traseiro esquerdo [psi].

tire_pressure_rear_right
number

Indica a pressão do pneu traseiro direito [psi].

oil_level
number

Indica o nível do óleo [%].

engine_cooling_temperature
number

Indica a temperatura do líquido de arrefecimento do motor [°C].

lv_battery_voltage
number

Indica a tensão da bateria de baixa tensão [V].

hv_battery_voltage
number

Indica a tensão da bateria de alta tensão [V].

hv_battery_soc
number

Indica o estado de carga da bateria de alta tensão [%].

hv_battery_charging_status
categorical

Indica o estado de carregamento da bateria de alta tensão. Os possíveis valores são:

  • charging: Carregando
  • not charging: Não Carregando
  • charged: Carregado
  • charging error: Erro de Carregamento
  • other: Outro
seat_belt_status
categorical

Indica o estado do cinto de segurança. Os possíveis valores são:

  • buckled: Afivelado
  • not buckled: Não Afivelado
event
categorical

Indica o evento que originou o registro do conjunto de dados. Os possíveis valores são:

  • periodical: Periódico
  • ignition on: Ignição Ligada
  • ignition off: Ignição Desligada
  • abrupt acceleration: Aceleração Brusca
  • abrupt brake: Freada Brusca
  • direction change: Mudança de Direção
  • lv battery low voltage: Baixa Tensão da Bateria LV
  • charging status change: Mudança de Estado de Carregamento
  • charging plug status change: Mudança de Estado do Plugue de Carregamento
  • other: Outro
flag
categorical

Indica quando um dado foi considerado como errôneo e foi corrigido, contendo o dado do qual se trata, o valor original e o tipo do erro.