Céges járművek

Általános leírás

A CompanyVehicles metódus visszaadja a járművek listáját és azok részleteit. Csak azokat a járműveket adja vissza, amelyekhez a felhasználónak hozzáférése van.
A válaszban található vehicleId értékek később felhasználhatók az API további metódusainak meghívásához.

A metódus a Rate Limit korlátozásai alá esik.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: GET https://api.trackgps.ro/api/carriers/company-vehicles?api-version=2.0

⚠️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Válasz szerkezete

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

Tulajdonságok leírása

• payload: A járművek listája és azok részletei.
  • vehicleId: A jármű egyedi azonosítója.
  • vehicleUId: A jármű univerzális egyedi azonosítója.
  • vehicleName: A jármű neve.
  • vehicleRegistrationNumber: A jármű rendszáma.
  • latitude: A jármű helyzetének szélességi foka.
  • longitude: A jármű helyzetének hosszúsági foka.
  • gpsDate: Az utolsó GPS-frissítés dátuma és ideje.
  • address: A jármű helyének címe.
  • speed: A jármű sebessége.
  • course: A jármű haladási iránya.
  • engineEvent: Motor esemény.
  • engineRpm: Motor fordulatszáma.
  • engineEventDate: A motor eseményének dátuma és ideje.
  • serverDate: A szerver válaszának dátuma és ideje.
  • isPrivate: Jelzi, hogy a jármű privát módban van-e.
  • vehicleIdentificationNumber: A jármű azonosító száma (VIN).
  • externalPowerVoltage: Tápfeszültség.
  • vehicleManufacturer: A jármű gyártója.
  • vehicleModel: A jármű modellje.
  • manufactureYear: A jármű gyártási éve.
• correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
• failureReasons: Hibák listája, ha vannak.
  • errorCode: Hibakód.
  • errorParameters: Hibához tartozó további paraméterek.
• isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Útvonal

Általános leírás

A Way metódus visszaadja a járművek helyzetét a megadott időszakban. Csak azokat a járműveket adja vissza, amelyekhez a felhasználónak hozzáférése van. A metódus legfeljebb 10 vehicleId-t és maximum 31 napos időszakot fogad el paraméterként.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/carriers/way?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Request paraméterek

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

• vehiclesList: Azoknak a járműveknek az vehicleId listája, amelyek helyzetét le szeretné kérdezni.
• startDate: Az időszak kezdő dátuma és ideje, amelyre a helyzetadatokat kéri.
• endDate: Az időszak záró dátuma és ideje, amelyre a helyzetadatokat kéri.

Válasz szerkezete

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

Tulajdonságok leírása

• payload: A járművek helyzetének listája.
  • vehicleId: A jármű egyedi azonosítója.
  • gpsDate: Az utolsó GPS-frissítés dátuma és ideje.
  • latitude: A jármű földrajzi szélessége.
  • longitude: A jármű földrajzi hossza.
  • speed: A jármű sebessége.
  • course: A jármű haladási iránya.
• correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
• failureReasons: A hibák listája, ha vannak.
  • errorCode: Hibakód.
  • errorParameters: További paraméterek a hibához.
• isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Megállások

Általános leírás

A Stops metódus visszaadja a járművek megállásainak listáját a lekérdezés időszakára vonatkozóan. Csak azoknak a járműveknek az adatait adja vissza, amelyekhez a felhasználónak hozzáférése van. Ha a lista tartalmaz legalább egy olyan járművet, amelyhez a felhasználónak nincs hozzáférése, akkor 401 hibakódú válasz érkezik.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/carriers/stops?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Request paraméterek

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

• vehiclesList: Azon járművek azonosítóinak listája, amelyek megállásaira vonatkozik a lekérdezés (legfeljebb 10 jármű).
• startDate: A lekérdezés kezdő dátuma és időpontja.
• endDate: A lekérdezés záró dátuma és időpontja.
• stationaryMargin: A megállás minimális időtartama percben (nem lehet kevesebb, mint 1 perc).

Válasz szerkezete

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

Tulajdonságok leírása

• payload: A járművek megállásainak listája.
  • results: Járművekhez tartozó megállások.
    • vehicleId: A jármű azonosítója.
    • startDate: A megállás kezdő dátuma és időpontja.
    • endDate: A megállás záró dátuma és időpontja.
    • latitude: A megállás helyének szélességi foka.
    • longitude: A megállás helyének hosszúsági foka.
    • stationaryEngineOnTime: A járó motorral való megállás idotartama.
    • distance: Megtett távolság.
    • maxSpeed: Elért maximális sebesség.
    • averageSpeed: Átlagsebesség.
    • speedCount: Sebességmérések száma.
    • indexKm: Kilométer index.
    • indexHours: Óra index.
    • address: A megállás helyének címe.
    • stopDuration: A megállás időtartama.
    • engineOnStops: Motor járása közbeni események listája.
      • startDate: A motor járása közbeni megállás kezdete.
      • endDate: A motor járása közbeni megállás vége.
      • duration: A motor járása közbeni megállás időtartama.
    • hotSpot: Hotspot neve, ha a megállás egy előre definiált hotspotban történt.
    • functioningTime: Működési idő.
    • isPrivate: Jelzi, hogy a megállás privát-e.
    • drivers: Sofőrök listája.
      • firstName: Sofőr keresztneve.
      • lastName: Sofőr vezetékneve.
    • fuelConsumption: Üzemanyag-fogyasztás az előző megállás végétől a jelenlegi megállásig valamint a jelenlegi megállás alatt (ha a motor járt).
• correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
• failureReasons: Hibák listája, ha vannak.
  • errorCode: Hibakód.
  • errorParameters: Hibához tartozó további paraméterek.
• isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Fogyasztás

Általános leírás

A Consumption metódus információkat ad vissza egy jármű fogyasztásáról, megtett távolságáról, üzemóráiról, valamint az átlagfogyasztásról 100 km-re vetítve, az adott lekérdezési időszakra. A metódus legfeljebb 10 járműre és maximum 31 napos időszakra hívható meg. Ha a jármű LPG-vel is felszerelt, mindkét forrás adatai visszaadásra kerülnek.

A metódus a Rate Limit korlátozásai alá esik.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben. URL: POST https://api.trackgps.ro/api/carriers/consumption?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

A kérés JSON szerkezete

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

Kérés tulajdonságai

• vehiclesList: Azon járművek listája, amelyekre a lekérdezés történik (tömb, vehicleId típus).
• startDate: A lekérdezési időszak kezdő dátuma.
• endDate: A lekérdezési időszak záró dátuma.

A válasz JSON szerkezete

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

Válasz tulajdonságai

Elsődleges tulajdonságok

• vehicleName: A jármű neve (string típus).
• licensePlate: Rendszám (string típus).
• distance: Megtett távolság km-ben (numerikus típus).
• hours: Üzemóra, időtartam formátumban óra:perc:másodperc (string típus).
• consumptionValue: Fogyasztás értéke literben (numerikus típus).
• averageConsumption100Km: Átlagfogyasztás 100 km-re vetítve, l/100km (numerikus típus).

Másodlagos forrás tulajdonságai

• secondarySource.distance: Másodlagos forrás által megtett távolság km-ben (numerikus típus).
• secondarySource.hours: Másodlagos forrás üzemórája, időtartam formátumban óra:perc:másodperc (string típus).
• secondarySource.consumptionValue: Másodlagos forrás fogyasztása literben (numerikus típus).
• secondarySource.averageConsumption100Km: Másodlagos forrás átlagfogyasztása 100 km-re vetítve, l/100km (numerikus típus).

Összesítések számítása

Ha a másodlagos forrás tartalmaz adatokat, az összesített értékekhez az elsődleges és másodlagos forrás adatait össze kell adni. Például:

{
  "payload": [
    {
      "vehicleName": "Jármű 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
}

Összesítések:

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

Tankolások

Általános leírás

A Refills metódus visszaadja a megadott időszakban észlelt tankolási vagy üzemanyagszint-csökkenési események listáját. Csak azokhoz a járművekhez tartozó adatokat adja vissza, amelyekhez a felhasználónak hozzáférése van.
Ha a lista legalább egy olyan járművet tartalmaz, amelyhez a felhasználónak nincs hozzáférése, 401 hibakódú válasz érkezik.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/carriers/refills?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Request paraméterek

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

• carrierId: Annak a járműnek az egyedi azonosítója, amelyhez tankolási vagy üzemanyagszint-csökkenési eseményeket szeretnénk lekérni.
• startDate: Az időszak kezdő dátuma és ideje, amelyre az eseményeket kérjük.
• endDate: Az időszak záró dátuma és ideje, amelyre az eseményeket kérjük.

Válasz szerkezete

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

Tulajdonságok leírása

• payload: A tankolási vagy üzemanyagszint-csökkenési események listája.
  • date: Az esemény dátuma és ideje.
  • event: Az esemény típusa (tankolás vagy üzemanyagszint-csökkenés).
  • location: Az esemény helyszíne.
  • estimation: Az eseményhez kapcsolódó üzemanyag mennyiségének becslése.
  • isPrivate: Jelzi, hogy az esemény magáncélú volt-e.
• correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
• failureReasons: A hibák listája, ha vannak.
  • errorCode: Hibakód.
  • errorParameters: Hibához tartozó további paraméterek.
• isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Lehetséges eseménytípusok listája

• FuelStart: Kezdő szint
• Fueling: Tankolás
• PossibleFuelTheft: Lehetséges üzemanyaglopás
• TotalRefill: Összes tankolás
• TotalPossibleTheft: Összes lehetséges üzemanyaglopás
• RemainingFuel: Maradék üzemanyag
• TotalFuelConsumption: Teljes üzemanyag-fogyasztás
• FuelStartSecondarySource: Másodlagos forrás kezdő szintje
• FuelingSecondarySource: Tankolás másodlagos forrásból
• PossibleFuelTheftSecondarySource: Lehetséges üzemanyaglopás másodlagos forrásból
• TotalRefillSecondarySource: Összes tankolás másodlagos forrásból
• TotalPossibleTheftSecondarySource: Összes lehetséges lopás másodlagos forrásból
• RemainingFuelSecondarySource: Maradék üzemanyag másodlagos forrásból
• TotalFuelConsumptionSecondarySource: Teljes üzemanyag-fogyasztás másodlagos forrásból

Hőmérsékletek

Az Általános Módszer Leírása

A Temperatures metódus visszaadja a lekérdezés időszakára vonatkozó rögzített hőmérsékleti adatokat. Csak azokhoz a járművekhez ad vissza adatokat, amelyekhez a felhasználónak hozzáférése van. Ha a lista tartalmaz legalább egy olyan járművet, amelyhez a felhasználónak nincs hozzáférése, akkor 401 hibakódú válasz érkezik.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/carriers/temperatures?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Kérés Paraméterei

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

• vehiclesList: Azoknak a járműveknek a listája, amelyekhez hőmérsékleti adatokat kérünk.
• startDate: Az időszak kezdő dátuma, amelyre az adatokat kérjük.
• endDate: Az időszak záró dátuma, amelyre az adatokat kérjük.

Válasz Struktúrája

{
  "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: Az eredményeket tartalmazza a hőmérsékleti adatokkal.
• correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
• failureReasons: Azok az okok, amelyek miatt a kérés sikertelen volt, ha vannak ilyenek.
• isSuccess: Jelzi, hogy a kérés sikeres volt-e.