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