Vehiculele companiei

Descriere Generală

Metoda CompanyVehicles returnează lista cu vehicule și detaliile acestora. Aceasta returnează doar vehiculele la care utilizatorul are acces.
Din răspunsul acestei metode se pot reține vehicleId-urile vehiculelor, care pot fi folosite ulterior la apelul celorlalte metode din API.

Este supus restricțiilor din Rate Limit

⚠️ Toate cererile către acest endpoint trebuie să includă parametrul api-version=2.0 în URL.
URL: GET https://api.trackgps.ro/api/carriers/company-vehicles?api-version=2.0

⚠️ Notă: Toate datele calendaristice transmise sau returnate de acest endpoint sunt în fusul orar local al companiei.

Structura Răspunsului

{
  "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
}

Descrierea Proprietăților

  • payload: Lista vehiculelor și detaliile acestora.
    • vehicleId: ID-ul unic al vehiculului.
    • vehicleUId: ID-ul unic universal al vehiculului.
    • vehicleName: Numele vehiculului.
    • vehicleRegistrationNumber: Numărul de înmatriculare al vehiculului.
    • latitude: Latitudinea locației vehiculului.
    • longitude: Longitudinea locației vehiculului.
    • gpsDate: Data și ora ultimei actualizări GPS.
    • address: Adresa locației vehiculului.
    • speed: Viteza vehiculului.
    • course: Direcția de deplasare a vehiculului.
    • engineEvent: Evenimentul motorului.
    • engineRpm: Turația motorului.
    • engineEventDate: Data și ora evenimentului motorului.
    • serverDate: Data și ora serverului la momentul răspunsului.
    • isPrivate: Indicator dacă vehiculul este în mod privat.
    • vehicleIdentificationNumber: Numărul de identificare al vehiculului (VIN).
    • externalPowerVoltage: Tensiunea de alimentare.
    • vehicleManufacturer: Producătorul vehiculului.
    • vehicleModel: Modelul vehiculului.
    • manufactureYear: Anul de fabricație al vehiculului.
  • correlationId: ID-ul unic pentru corelarea cererii și răspunsului.
  • failureReasons: Lista motivelor de eșec, dacă există.
    • errorCode: Codul de eroare.
    • errorParameters: Parametrii suplimentari pentru eroare.
  • isSuccess: Indicator dacă cererea a fost procesată cu succes.