Alert Data

This API is meant to return alert data information based on given data.

POSThttps://yourdomain.com/webservice?token=getAlertData

Request Parameters

Parameter	Type	Description
access_token	String	Access Token
username	String	Account Username and is mandatory
password	String	Account Password and is mandatory
format	String	json/xml
from	Long	From Date(Optional)
to	Long	To Date (Optional)
vehicle	JSON	Vehicle Number (Optional)
imei_number	JSON	IMEI numbers (Optional)
alert_id	JSON	Alert ID (Optional)

Description

Method Name

getAlertData

Prerequisites

Before calling this API we need to generate token using generateAccessToken API.

Acceptance Criteria

API is specific to Trakzee Premium.
Single user rights.
Time duration should not be greater than 24 hrs.

Response Description

Key	Format	Description
company	String	Company Name
branch	String	Branch Name
vehicle_no	String	Vehicle Number
vehicle_name	String	Vehicle Name
driver	String	Driver Name
imei	Long	Vehicle IMEI No
alert_generation	String	Alert Date Time
alert_type	String	Alert Category Name
alert_info	String	Alert Info
alert_duration	String	Address name
alert_location	String	End Location
alert_id	Integer	Alert ID
latitude	Double	Start Latitude
longitude	Double	Start Longitude
zip_code	String	Zip Code
description	String	Description

Error Code	Status
0	Fail
1	Success

Sample Response

Success message

[
{
  "status": 1,
  "data": [
    {
      "company": "XXX",
      "branch": "XXXXXX",
      "vehicle_no": "XX",
      "vehicle_name": "XXXX XXX",
      "driver": "XXX XXXX",
      "imei": 0l,
      "alert_generation": "XXX",
      "alert_type": "XXX",
      "alert_info": "XX",
      "alert_duration": "XXX",
      "alert_location": "XXXXXXXXX  XXXXXX  XXX",
      "alert_id": 0,
      "latitude": 0.0,
      "longitude": 0.0,
      "zip_code": "--",
      "description": "--"
    },
    {
      "company": "XXX",
    }
  ],
  "message": "XXXXXXX"
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "Token is invalid or expired"
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "Insufficient request parameters."
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "Time duration should not be greater than 24 hours."
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "User license expired."
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "No Records Found."
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "Multiple project rights found on user."
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "Invalid Username/Password"
}

FAIL

{
    "result": 0,
    "data": [],
    "message": "Something went wrong on server."
}

Response codes

Code	Description

Error codes

Code	Name	Description