Basic Information

Detailed Information

Report Data

The Vehicle Datatype

The following datatype will be JSONified and returned for methods which retrieve Vehicle values. Method requests which update existing Vehicles will be parsed for a JSON representation of this data structure.

When modifying an existing Vehicle, please set the AccountId to 0, or your AccountId as returned by the /Account method. Any other value will result in an Authentication error.

public class Vehicle
{
publicUInt64DeviceId; // A unique identifier for the Device. Use this when making further API calls specific to this device.
publicStringVIN; // VIN of vehicle
publicStringFuelCardNumber; // Fuel Card assigned to vehicle
publicUInt64Miles; // Miles
publicUInt64Hours; // Hours
}

The Vehicle Methods

The following list provides a reference for all valid /Vehicle HTTP requests.

  • GET v1/Vehicle?account={account}

    Summary: Returns vehicle rows for all vehicles associated with the account.

    Returns: Vehicle rows

    Parameters:

    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
  • GET v1/Vehicle?deviceid={deviceid}&account={account}

    Summary: Returns a Vehicle row for the given Device ID.

    Returns: Vehicle row

    Parameters:

    • deviceid: Device ID (FromUri)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)
  • PUT v1/Vehicle?account={account}

    Summary: Update an existing vehicle entry with new information.

    Returns: Vehicle row

    Parameters:

    • ToUpdate: A JSONified Vehicle object, representing the record to update as it should be updated. (FromBody)
    • account: (Optional) If this parameter is included, the method will be run on behalf of the specified child Account (if valid). (FromUri)