Adatküldési szüneteltetés
Általános leírás
A pause-transports végpont lehetővé teszi egy aktív fuvar pozíciójának továbbításának szüneteltetését UIT kód alapján. Hasonlóan a start és stop végpontokhoz, a fuvarok ideiglenesen szüneteltethetők.
A Rate Limit korlátozásai érvényesek.
⚠️ Minden kéréshez kötelező az
api-version=2.0paramétert megadni az URL-ben.
URL:POST https://api.trackgps.ro/api/eTransport/pause-transports?api-version=2.0
Kérelem 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
-
Törzs (JSON):
{
"transports": [
{
"codeUit": "string"
}
]
}| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
| transports | tömb | Igen | A szüneteltetendő fuvarok listája. |
| codeUit | string | Igen | A fuvar egyedi UIT azonosító kódja. |
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 | boolean | A szüneteltetés művelet eredménye (true, ha sikeres volt). |
| correlationId | string | Egyedi azonosító a kéréshez, nyomon követéshez hasznos. |
| failureReasons | tömb | Hibák listája (ha vannak), mindegyik kóddal és paraméterekkel. |
| 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 | Nem hitelesített vagy jogosulatlan felhasználó. |
| 429 | A felhasználó túllépte a rate limit-et. |