Notifications
Notification List
Use this API to get all notifications received by a Trainee.
GET /notification/trainee-notification-list Try now
Query string parameters
| Field | Type | Description |
|---|---|---|
| firstRecord required | integer | First record to return. Default: 1 |
| count required | integer | Number of records to be returned starting from the first record. Default: 20, Max count limit: 50 |
| q | string | filter data by subject |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"notificationList": [
{
"notificationId": 2116249,
"subject": "You have been enrolled to New Course",
"sentDate": "2023-08-29 13:28:44",
"isViewed": false
}
],
"totalRecords": 37
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| notificationList | array | Array of notification objects. |
| notificationId | number | ID of the notification. |
| subject | string | Subject of the notification. |
| sentDate | string | Date and time when the notification was sent. |
| isViewed | boolean | Indicates if the notification has been viewed. |
| totalRecords | number | Total number of records in the response. |
| Code | Description |
|---|---|
| 1001 | "Invalid firstRecord" |
| 1002 | "Invalid count" |
Notification Details
Use this API to get notification details.
GET /notification/{notificationId}/trainee-notification-detail Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| notificationId required | integer | The notification ID |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"subject": "You have been enrolled to New Course",
"body": "<p>You have been enrolled to the course <strong>Principles of an Effective Manager</strong>. You can access your course material by clicking on this link: <strong><a href=\"app.alphalearn.com\">app.alphalearn.com</a></strong></p>\r\n\r\n<p>Your course material will be available till <strong>28-09-2023</strong>.</p>\r\n\r\n<p>If you would like to reset your password, please click on forgot password link on the login page.</p>\r\n\r\n<p>All the best,</p>\r\n\r\n<p>Team AlphaLearn</p>",
"sentDate": "2023-08-29 13:28:44"
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| subject | string | Subject of the notification. |
| body | string | HTML body of the notification. |
| sentDate | string | Date and time when the notification was sent. |