Adatküldési szakasz leállítása

Általános leírás

Az end-transports végpont lehetővé teszi egy vagy több aktív fuvarok leállítását UIT kód alapján. Ezzel a művelettel a fuvarok lezárásra kerülnek a rendszerben, és később már nem módosíthatók.

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

⚠️ Minden kéréshez kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/eTransport/end-transports?api-version=2.0


Kérés paraméterei

A végponthoz POST típusú kérést kell küldeni az alábbi paraméterekkel:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0
  • Body (JSON):

{
  "transports": [
    {
      "codeUit": "string"
    }
  ]
}
Paraméter Típus Kötelező Leírás
transports array Igen A leállítandó fuvarok listája.
codeUit string Igen A fuvar egyedi UIT azonosítója.

🕒 Fontos: Minden dátum (endDate) UTC formátumban legyen megadva.


Válasz szerkezete

{
  "payload": {
    "codeUit": "string",
    "isSuccess": true,
    "errors": [
      "string"
    ]
  },
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload boolean A leállítás eredménye (true, ha sikeres volt).
correlationId string Egyedi azonosító a kéréshez, nyomon követéshez.
failureReasons array Hibák listája (ha vannak), mindegyik tartalmaz kódot és paramétereket.
isSuccess boolean Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true vagy false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó, érvénytelen vagy hibás formátumú paraméterek.
401 Nincs hitelesítés vagy jogosultság.
429 Felhasználó túllépte a rate limit-et.