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.

Traseu

Descriere Generală

Metoda Way returnează lista cu locațiile vehiculelor din perioada transmisă ca parametru. Aceasta returnează doar vehiculele la care utilizatorul are acces. Metoda acceptă ca parametri o listă de maxim 10 vehicleId și o perioadă de maxim 31 de zile.

Este supus restricțiilor din Rate Limit

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

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

Parametri Request

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T09:21:50.133",
  "endDate": "2024-09-09T09:21:50.133"
}

• vehiclesList: Lista de vehicleId-uri pentru care se dorește obținerea locațiilor.
• startDate: Data și ora de început a perioadei pentru care se solicită locațiile.
• endDate: Data și ora de sfârșit a perioadei pentru care se solicită locațiile.

Structura Răspunsului

{
  "payload": [
    {
      "vehicleId": 0,
      "gpsDate": "2024-09-09T09:21:50.134~~~~",
      "latitude": 0,
      "longitude": 0,
      "speed": 0,
      "course": 0
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Descrierea Proprietăților

• payload: Lista locațiilor vehiculelor.
  • vehicleId: ID-ul unic al vehiculului.
  • gpsDate: Data și ora ultimei actualizări GPS.
  • latitude: Latitudinea locației vehiculului.
  • longitude: Longitudinea locației vehiculului.
  • speed: Viteza vehiculului.
  • course: Direcția de deplasare a 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.

Staționări

Descriere Generală

Metoda Stops returnează o listă cu staționările vehiculelor în perioada pentru care se face apelul. Aceasta returnează doar datele pentru vehiculele la care utilizatorul are acces. În cazul în care lista conține cel puțin un vehicul la care utilizatorul nu are acces, se va returna un răspuns cu cod de eroare 401.

Este supus restricțiilor din Rate Limit

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

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

Parametri Request

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T09:49:19.549",
  "endDate": "2024-09-09T09:49:19.549",
  "stationaryMargin": 0
}

• vehiclesList: Lista de ID-uri ale vehiculelor pentru care se solicită staționările (maxim 10 vehicule).
• startDate: Data și ora de început a perioadei pentru care se solicită staționările.
• endDate: Data și ora de sfârșit a perioadei pentru care se solicită staționările.
• stationaryMargin: Timpul de staționare exprimat în minute (nu poate fi mai mic de 1 minut).

Structura Răspunsului

{
  "payload": [
    {
      "results": {
        "additionalProp1": [
          {
            "vehicleId": 0,
            "startDate": "2025-04-11T14:33:30.175",
            "endDate": "2025-04-11T14:33:30.175",
            "latitude": 0,
            "longitude": 0,
            "stationaryEngineOnTime": 0,
            "distance": 0,
            "maxSpeed": 0,
            "averageSpeed": 0,
            "speedCount": 0,
            "indexKm": 0,
            "indexHours": 0,
            "address": "string",
            "stopDuration": 0,
            "engineOnStops": [
              {
                "startDate": "2025-04-11T14:33:30.175",
                "endDate": "2025-04-11T14:33:30.175",
                "duration": 0
              }
            ],
            "hotSpot": "string",
            "functioningTime": 0,
            "isPrivate": true,
            "drivers": [
              {
                "firstName": "string",
                "lastName": "string"
              }
            ],
            "fuelConsumption": 0
          }
        ],
        "additionalProp2": [
          {
            "vehicleId": 0,
            "startDate": "2025-04-11T14:33:30.175",
            "endDate": "2025-04-11T14:33:30.175",
            "latitude": 0,
            "longitude": 0,
            "stationaryEngineOnTime": 0,
            "distance": 0,
            "maxSpeed": 0,
            "averageSpeed": 0,
            "speedCount": 0,
            "indexKm": 0,
            "indexHours": 0,
            "address": "string",
            "stopDuration": 0,
            "engineOnStops": [
              {
                "startDate": "2025-04-11T14:33:30.175",
                "endDate": "2025-04-11T14:33:30.175",
                "duration": 0
              }
            ],
            "hotSpot": "string",
            "functioningTime": 0,
            "isPrivate": true,
            "drivers": [
              {
                "firstName": "string",
                "lastName": "string"
              }
            ],
            "fuelConsumption": 0
          }
        ],
        "additionalProp3": [
          {
            "vehicleId": 0,
            "startDate": "2025-04-11T14:33:30.175",
            "endDate": "2025-04-11T14:33:30.175",
            "latitude": 0,
            "longitude": 0,
            "stationaryEngineOnTime": 0,
            "distance": 0,
            "maxSpeed": 0,
            "averageSpeed": 0,
            "speedCount": 0,
            "indexKm": 0,
            "indexHours": 0,
            "address": "string",
            "stopDuration": 0,
            "engineOnStops": [
              {
                "startDate": "2025-04-11T14:33:30.175",
                "endDate": "2025-04-11T14:33:30.175",
                "duration": 0
              }
            ],
            "hotSpot": "string",
            "functioningTime": 0,
            "isPrivate": true,
            "drivers": [
              {
                "firstName": "string",
                "lastName": "string"
              }
            ],
            "fuelConsumption": 0
          }
        ]
      }
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Descrierea Proprietăților

• payload: Lista staționărilor vehiculelor.
  • results: Rezultatele staționărilor pentru fiecare vehicul.
    • vehicleId: ID-ul vehiculului.
    • startDate: Data și ora de început a staționării.
    • endDate: Data și ora de sfârșit a staționării.
    • latitude: Latitudinea locației staționării.
    • longitude: Longitudinea locației staționării.
    • stationaryEngineOnTime: Timpul de staționare cu motorul pornit.
    • distance: Distanța parcursă.
    • maxSpeed: Viteza maximă atinsă.
    • averageSpeed: Viteza medie.
    • speedCount: Numărul de măsurători de viteză.
    • indexKm: Indexul de kilometri.
    • indexHours: Indexul de ore.
    • address: Adresa locației staționării.
    • stopDuration: Durata staționării.
    • engineOnStops: Lista evenimentelor cu motorul pornit.
      • startDate: Data și ora de început a staționării cu motorul pornit.
      • endDate: Data și ora de sfârșit a staționării cu motorul pornit.
      • duration: Durata staționării cu motorul pornit.
    • hotSpot: Numele hotspotului daca stationarea s-a produs în unul din hotspoturile definite.
    • functioningTime: Timpul de funcționare.
    • isPrivate: Indicator dacă staționarea este privată.
    • drivers: Lista șoferilor.
      • firstName: Prenumele șoferului.
      • lastName: Numele de familie al șoferului.
    • fuelConsumption: Consumul de combustibil pe deplasarea anterioară şi staţionarea curentă (dacă s-a staţionat cu motorul pornit).
• 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.

Consum

Descriere Generală

Metoda Consumption returnează informații despre consumul, distanța, orele de funcționare, cât și consumul mediu la 100 km al unui vehicul în perioada pentru care se face apelul la metodă. Metoda poate fi apelată pentru o listă de maximum 10 vehicule și o perioadă de maximum 31 zile. Dacă vehiculul este echipat cu GPL, vor fi returnate date pentru ambele surse.

Este supus restricțiilor din Rate Limit

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

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

Structura JSON a Cererii

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T07:15:14.124",
  "endDate": "2024-09-09T07:15:14.124"
}

Proprietăți ale Cererii

• vehiclesList: Listă de vehicule pentru care se face apelul (tip array de vehicleId).
• startDate: Data de început a perioadei pentru care se face apelul.
• endDate: Data de sfârșit a perioadei pentru care se face apelul.

Structura JSON a Răspunsului

{
  "payload": [
    {
      "vehicleName": "string",
      "licensePlate": "string",
      "distance": 0,
      "hours": "string",
      "consumptionValue": 0,
      "averageConsumption100Km": 0,
      "secondarySource": {
        "distance": 0,
        "hours": "string",
        "consumptionValue": 0,
        "averageConsumption100Km": 0
      }
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Proprietăți ale Răspunsului

Proprietăți Primare

• vehicleName: Numele vehiculului (tip string).
• licensePlate: Numărul de înmatriculare (tip string).
• distance: Distanța parcursă în km (tip numeric).
• hours: Orele de funcționare în format timespan ore:minute:secunde (tip string).
• consumptionValue: Valoarea consumului în litri (tip numeric).
• averageConsumption100Km: Consum mediu la 100 km în l/100km (tip numeric).

Proprietăți Sursă Secundară

• secondarySource.distance: Distanța parcursă de sursa secundară în km (tip numeric).
• secondarySource.hours: Orele de funcționare ale sursei secundare în format timespan ore:minute:secunde (tip string).
• secondarySource.consumptionValue: Valoarea consumului pentru sursa secundară în litri (tip numeric).
• secondarySource.averageConsumption100Km: Consum mediu la 100 km pentru sursa secundară în l/100km (tip numeric).

Calcularea Totalurilor

În cazul în care sursa secundară conține date, pentru obținerea totalurilor trebuie însumate datele din sursa primară și sursa secundară. De exemplu:

{
  "payload": [
    {
      "vehicleName": "Vehicul A",
      "licensePlate": "AB-12-BCD",
      "distance": 100,
      "hours": "10:00:00",
      "consumptionValue": 50,
      "averageConsumption100Km": 5,
      "secondarySource": {
        "distance": 50,
        "hours": "5:00:00",
        "consumptionValue": 20,
        "averageConsumption100Km": 4
      }
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isSuccess": true
}

Totaluri:

• distance: 100 + 50 = 150 km
• hours: 10:00:00 + 5:00:00 = 15:00:00
• consumptionValue: 50 + 20 = 70 litri
• averageConsumption100Km: (5 + 4) / 2 = 4.5 l/100km

Alimentări

Descriere Generală

Metoda Refills returnează o listă cu evenimentele de alimentare sau scădere a nivelului de carburant detectate în perioada pentru care se face apelul. Aceasta returnează doar datele pentru vehiculele la care utilizatorul are acces.
În cazul în care lista conține cel puțin un vehicul la care utilizatorul nu are acces, se va returna un răspuns cu cod de eroare 401.

Este supus restricțiilor din Rate Limit

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

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

Parametri Request

{
  "carrierId": 0,
  "startDate": "2024-09-09T09:42:51.835",
  "endDate": "2024-09-09T09:42:51.835"
}

• carrierId: ID-ul unic al vehiculului pentru care se dorește obținerea evenimentelor de alimentare sau scădere a nivelului de carburant.
• startDate: Data și ora de început a perioadei pentru care se solicită evenimentele.
• endDate: Data și ora de sfârșit a perioadei pentru care se solicită evenimentele.

Structura Răspunsului

{
  "payload": [
    {
      "date": "string",
      "event": "string",
      "location": "string",
      "estimation": 0,
      "isPrivate": true
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Descrierea Proprietăților

• payload: Lista evenimentelor de alimentare sau scădere a nivelului de carburant.
  • date: Data și ora evenimentului.
  • event: Tipul evenimentului (alimentare sau scădere a nivelului de carburant).
  • location: Locația unde a avut loc evenimentul.
  • estimation: Estimarea cantității de carburant implicate în eveniment.
  • isPrivate: Indicator dacă evenimentul s-a efectuat în mod privat.
• 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.

Lista Posibile Evenimente

• FuelStart: Nivel început
• Fueling: Alimentare
• PossibleFuelTheft: Posibil furt de carburant
• TotalRefill: Total alimentări
• TotalPossibleTheft: Total posibile furturi de carburant
• RemainingFuel: Carburant rămas
• TotalFuelConsumption: Consum total de carburant
• FuelStartSecondarySource: Începutul alimentării din sursă secundară
• FuelingSecondarySource: Alimentare din sursă secundară
• PossibleFuelTheftSecondarySource: Posibil furt de carburant din sursă secundară
• TotalRefillSecondarySource: Total alimentări din sursă secundară
• TotalPossibleTheftSecondarySource: Total posibile furturi din sursă secundară
• RemainingFuelSecondarySource: Carburant rămas din sursă secundară
• TotalFuelConsumptionSecondarySource: Consum total de carburant din sursă secundară

Temperaturi

Descrierea Metodei Generale

Metoda Temperatures returnează o listă de temperaturi înregistrate pentru perioada pentru care se face apelul. Returnează date doar pentru vehiculele la care utilizatorul are acces. Dacă lista conține cel puțin un vehicul la care utilizatorul nu are acces, se va returna un răspuns cu codul de eroare 401.

Este supus restricțiilor din Rate Limit

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

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

Parametri Cererii

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T09:49:19.549",
  "endDate": "2024-09-09T09:49:19.549"
}

• vehiclesList: Lista vehiculelor pentru care se solicită datele de temperatură.
• startDate: Data de început a perioadei pentru care se solicită datele.
• endDate: Data de sfârșit a perioadei pentru care se solicită datele.

Structura Răspunsului

{
  "payload": [
    {
      "temperature": [
        {
          "vehicleId": 0,
          "date": "2025-04-11T12:33:11.817",
          "value": 0,
          "sensorNumber": 0
        }
      ],
      "humidity": [
        {
          "vehicleId": 0,
          "date": "2025-04-11T12:33:11.817",
          "value": 0,
          "sensorNumber": 0
        }
      ]
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

• payload: Conține rezultatele cu datele de temperatură.
• correlationId: Un identificator unic pentru corelarea cererii și răspunsului.
• failureReasons: Motivele pentru care cererea a eșuat, dacă există.
• isSuccess: Indică dacă cererea a fost de succes.