Request Filters

Request filters allow you to filter the data that the API returns, for example limiting a fuel-log listing to entries between specific dates.

All filters should be within the main JSON encapsulated request, under variable 'filter'.

Key/value pairs within the filters object should specify what to filter on, the full range of supported keys varies by submodule, but the global filters are detailed below

Date

Date can be passed as a value (i.e. match exactly) or as an array - start and end.

filters{
"Date":[ '2013-10-14','2013-10-15' ]
}

Date should always be passed in MySQL format

 

Fuel Filters

Valid filters are;

  • Date
  • Garage
  • Mileage
  • MileageLess
  • MileageMore
  • Cost
  • CostLess
  • CostMore

 

Service Filters

Valid filters are;

  • Date
  • Garage
  • Mileage
  • MileageLess
  • MileageMore
  • Cost
  • CostLess
  • CostMore
  • Work
  • Fault

Journey Filters

  • Order (ASC/DESC) - Currently only supported on ListJourneys