Ú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.