Skip to main content
POST
/
api
/
GetAlerts
Get alerts
curl --request POST \
  --url https://api.telemax.com.au/api/GetAlerts \
  --header 'Authorization: <authorization>'
[
  {
    "id": 101,
    "utcTime": "2024-01-15T10:30:00Z",
    "userTime": "2024-01-15T12:30:00+02:00",
    "userTimeFormatted": "15/01/2024 12:30:00",
    "alertType": "Overspeed",
    "description": "Vehicle exceeded speed limit by 25 km/h",
    "vehicleId": 12345,
    "vehicleName": "Fleet Vehicle 002",
    "address": "456 Broadway, New York, NY 10012",
    "lat": 40.7218,
    "lng": -73.999,
    "isRead": false
  }
]

Headers

​
Content-Type
string

Standard and must keep as it is.

​
Authorization
string
required

Bearer your_token

Query Parameters

​
compId
integer
required

Company ID.

​
from
string
required

Starting date.

​
num
string
required

Maximum number of alerts to get.

Response

200 - application/json

Successful response with array of alert records

​
id
integer

Alert ID

Example:

101

​
utcTime
string<date-time> | null

Time in UTC

Example:

"2024-01-15T10:30:00Z"

​
userTime
string<date-time> | null

Time in user timezone

Example:

"2024-01-15T12:30:00+02:00"

​
userTimeFormatted
string

User time formatted

Example:

"15/01/2024 12:30:00"

​
alertType
string

Alert type

Example:

"Overspeed"

​
description
string

Description of the alert

Example:

"Vehicle exceeded speed limit by 25 km/h"

​
vehicleId
integer

Vehicle ID

Example:

12345

​
vehicleName
string

Name of the vehicle

Example:

"Fleet Vehicle 002"

​
address
string

Address where the alert occurred

Example:

"456 Broadway, New York, NY 10012"

​
lat
number<double>

Latitude

Example:

40.7218

​
lng
number<double>

Longitude

Example:

-73.999

​
isRead
boolean

Whether the alert has been read

Example:

false