Announcements
Announcement List
Use this API to get all announcements received by a Trainee.
GET /announcement/trainee-announcement-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 title and description |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"announcementList": [
{
"announcementId": 2197,
"announcementSentId": 621997,
"subject": "Hello All",
"sentDate": "2022-12-30 11:33:04",
"isViewed": true
}
],
"totalRecords": 37
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| announcementList | array | Array of announcement objects. |
| announcementId | number | ID of the announcement. |
| announcementSentId | number | ID of the sent announcement. |
| subject | string | Subject of the announcement. |
| sentDate | string | Date and time when the announcement was sent. |
| isViewed | boolean | Indicates if the announcement has been viewed. |
| totalRecords | number | Total number of records in the response. |
| Code | Description |
|---|---|
| 1001 | "Invalid firstRecord" |
| 1002 | "Invalid count" |
Announcement Details
Use this API to get details of an announcement.
GET /trainee-announcement-detail/{announcementId}/{announcementSentId} Try now
Path parameters
| Field | Type | Description |
|---|---|---|
| announcementId required | integer | The announcement ID |
| announcementSentId required | integer | The announcement sent ID |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"title": "Hello All",
"description": "<p>Hello</p>",
"attachment": null
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| title | string | Title of the announcement. |
| description | string | Description of the announcement. |
| attachment | string | Attachment related to the announcement. |
Frontend Announcement Details
Use this API to get the list of announcements for frontend websites.
GET /announcement/front-end-announcement-list Try now
Path 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: 100 |
| type required | integer | 1-web, 2-microsite |
| q | string | filter data by title and description |
For general error details, click here.
- Response
- Schema
- Error Codes
{
"success": true,
"data": {
"response": {
"acknowledgement": "Success",
"data": {
"announcementList": [
{
"announcementId": 2197,
"title": "Hello",
"description": "Hello All",
}
],
"totalRecords": 1
},
"error": {
"code": "",
"internal_message": "",
"moreInfo": []
}
}
}
}
| Field | Type | Description |
|---|---|---|
| announcementList | array | Array of announcement objects. |
| announcementId | number | ID of the announcement. |
| title | string | Title of the announcement. |
| description | string | Description of the announcement. |
| totalRecords | number | Total number of records in the response. |