Notifications
This domain serves a endpoints to retrive notifications.
Get Notifications
POSTRetrieves notifications for a specific user based on user ID.
Request Paramters
stringdomain |
Value should be notifications |
Required |
stringaction |
Value should be get_notifications |
Required |
objectdata |
Contains input parameters. | Required |
intuser_id |
The ID of the user to fetch notifications for. | Required |
Sample Request Body
{
domain: "notifications",
action: "get_notifications",
data: {
user_id: 69
}
}
Response Paramters
stringstatus |
This indicate the status of the response. success is the expected value. |
stringmessage |
This explains the reson for status. |
objectdata |
This contain result data object of the API call. |
listdata |
An list containing status and notifications data. |
stringcode |
Unique code identifying the notification. |
stringsender |
Sender of the notification. |
stringtype |
Type of notification. |
stringmessage |
Message content of the notification. |
stringurl |
URL associated with the notification. |
stringn_date |
Date of the notification formatted as DD-MM-YYYY. |
stringn_time |
Time of the notification formatted as HH:MM:SS. |
stringcolor |
Hex color code associated with the notification. |
Sample Response
{
status: "success",
data: {
status: "success",
message: "Notifications Read",
data: [
1,
[
{
code: "666016e3bdebe",
sender: "Test",
type: "job_ecd",
message: "ETA (6/5/2024) reminder of Quote# Q03240017 - Job# J0005",
url: "view-quote.php?customer_id=1&customer_no=C240001"e_id=31"e_no=Q03240017",
n_date: "05-06-2024",
n_time: "06:42:27",
color: "2980B9"
}
]
]
}
}