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