Company Vehicles

General Description

The CompanyVehicles method returns the list of vehicles and their details. It only returns vehicles to which the user has access.
From the response of this method, you can retrieve the vehicleId values, which can be used in subsequent API calls.

This method is subject to Rate Limit restrictions.

⚠️ All requests to this endpoint must include the api-version=2.0 parameter in the URL.
URL: GET https://api.trackgps.ro/api/carriers/company-vehicles?api-version=2.0

⚠️ Note: All date and time values sent or returned by this endpoint are in the company’s local time zone.


Response Structure

{
  "payload": [
    {
      "vehicleId": 0,
      "vehicleUId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vehicleName": "string",
      "vehicleRegistrationNumber": "string",
      "latitude": 0,
      "longitude": 0,
      "gpsDate": "2024-09-09T08:52:55.005",
      "address": "string",
      "speed": 0,
      "course": 0,
      "engineEvent": 0,
      "engineRpm": 0,
      "engineEventDate": "2024-09-09T08:52:55.005",
      "serverDate": "2024-09-09T08:52:55.005",
      "isPrivate": true,
      "vehicleIdentificationNumber": "string",
      "externalPowerVoltage": 0,
      "vehicleManufacturer": "string",
      "vehicleModel": "string",
      "manufactureYear": 0
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Property Descriptions

  • payload: List of vehicles and their details.
    • vehicleId: Unique ID of the vehicle.
    • vehicleUId: Universal unique ID of the vehicle.
    • vehicleName: Name of the vehicle.
    • vehicleRegistrationNumber: Vehicle registration number.
    • latitude: Latitude of the vehicle’s location.
    • longitude: Longitude of the vehicle’s location.
    • gpsDate: Date and time of the last GPS update.
    • address: Address of the vehicle’s location.
    • speed: Vehicle speed.
    • course: Vehicle travel direction.
    • engineEvent: Engine event.
    • engineRpm: Engine RPM.
    • engineEventDate: Date and time of the engine event.
    • serverDate: Server date and time at the moment of response.
    • isPrivate: Indicates if the vehicle is in private mode.
    • vehicleIdentificationNumber: Vehicle Identification Number (VIN).
    • externalPowerVoltage: Power supply voltage.
    • vehicleManufacturer: Vehicle manufacturer.
    • vehicleModel: Vehicle model.
    • manufactureYear: Vehicle manufacture year.
  • correlationId: Unique ID for correlating the request and response.
  • failureReasons: List of failure reasons, if any.
    • errorCode: Error code.
    • errorParameters: Additional error parameters.
  • isSuccess: Indicates if the request was processed successfully.