POST
/
vehicle-trips
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 das viagens que se deseja recuperar dos veículos. As opções são:

  • start_date_time: Data e Hora de Início da Viagem [YYYY-MM-DDTHH:MM:SS]
  • end_date_time: Data e Hora de Fim da Viagem [YYYY-MM-DDTHH:MM:SS]
  • duration: Duração da Viagem [HH:MM:SS]
  • avg_speed: Velocidade Média [km/h]
  • max_speed: Velocidade Máxima [km/h]
  • start_odometer: Odômetro de Início [km]
  • end_odometer: Odômetro de Fim [km]
  • distance: Distância Percorrida [km]
  • avg_fuel_consumption: Consumo Médio de Combustível [L]
  • start_latitude: Latitude de Início [°]
  • start_longitude: Longitude de Início [°]
  • end_latitude: Latitude de Fim [°]
  • end_longitude: Longitude de Fim [°]
start_date
date or datetime

É um parâmetro opcional e pode ser usado para filtrar a data de início dos dados da viagem. 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 da viagem. 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, as viagens selecionadas serão as que pelo menos uma parte pertence ao período selecionado, da seguinte forma: (end_date >= start_date_time) | (end_date_time >= start_date)

Response

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

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

start_date_time
datetime

Indica o data e horário de início [YYYY-MM-DDTHH:MM:SS].

end_date_time
datetime

Indica o data e horário de fim [YYYY-MM-DDTHH:MM:SS].

duration
interval

Indica a duração [HH:MM:SS].

avg_speed
number

Indica a velocidade média [km/h].

max_speed
number

Indica a velocidade máxima [km/h].

start_odometer
number

Indica o odômetro inicial [km].

end_odometer
number

Indica o odômetro final [km].

distance
number

Indica a distância percorrida [km].

avg_fuel_consumption
number

Indica o consumo médio de combustível [km/l].

start_latitude
number

Indica a latitude do início [km/l].

start_latitude
number

Indica a latitude do início [°].

end_latitude
number

Indica a latitude do fim [°].

end_longitude
number

Indica a longitude do fim [°].