Fuvarok törlése

Általános leírás

A remove-transports végpont lehetővé teszi egy vagy több fuvar törlését a rendszerből az egyedi azonosítók (transportUId) alapján. Ez a művelet visszavonhatatlan, és megfelelő jogosultságokat igényel az érintett fuvarokra.

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/eTransport/remove-transports?api-version=2.0

Kérés paraméterei

A végponthoz küldött kéréseknek POST típusúnak kell lenniük, és a következő paramétereket kell tartalmazniuk:

  • Query paraméter:

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

  • Body (JSON):

{
  "transportsUids": [
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
Paraméter Típus Kötelező Leírás
transportsUids tömb Igen Az egyedi fuvar azonosítók (GUID) listája, amelyeket törölni kell.

Válasz szerkezete

{
  "payload": true,
  "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 logikai A törlési művelet eredménye (true, ha sikeres volt).
correlationId string Egyedi kérésazonosító, nyomon követéshez hasznos.
failureReasons tömb Hibák listája (ha vannak), mindegyik tartalmaz kódot és paramétereket.
isSuccess logikai 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ítve a felhasználó vagy nincs jogosultsága.
429 A felhasználó túllépte a rate limit-et.