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.