GET classroomAPI/Portal/getUnreadNotifications?userID={userID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Notification| Name | Description | Type | Additional information |
|---|---|---|---|
| mailID | globally unique identifier |
None. |
|
| parentMailID | globally unique identifier |
None. |
|
| fromUserID | integer |
None. |
|
| toUserID | integer |
None. |
|
| toOrganisationID | integer |
None. |
|
| priority | integer |
None. |
|
| flagged | boolean |
None. |
|
| opened | boolean |
None. |
|
| msgDate | date |
None. |
|
| msgType | integer |
None. |
|
| Message | string |
None. |
|
| subject | string |
None. |
|
| imageURL | string |
None. |
|
| videoURL | string |
None. |
|
| readDate | date |
None. |
|
| updated | date |
None. |
|
| cssClass | string |
None. |
|
| published | boolean |
None. |
|
| publishStart | date |
None. |
|
| publishEnd | date |
None. |
|
| heading | string |
None. |
|
| subheading | string |
None. |
|
| localNotification | boolean |
None. |
|
| emailNotification | boolean |
None. |
|
| pushNotification | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"mailID": "ac3c6ac5-8e94-4c3a-be38-a289af77141d",
"parentMailID": "74bb598a-2d43-47e7-9c10-daa96b220e82",
"fromUserID": 1,
"toUserID": 1,
"toOrganisationID": 1,
"priority": 3,
"flagged": true,
"opened": true,
"msgDate": "2025-11-08T11:29:07.3542643-05:00",
"msgType": 7,
"Message": "sample string 8",
"subject": "sample string 9",
"imageURL": "sample string 10",
"videoURL": "sample string 11",
"readDate": "2025-11-08T11:29:07.3542643-05:00",
"updated": "2025-11-08T11:29:07.3542643-05:00",
"cssClass": "sample string 12",
"published": true,
"publishStart": "2025-11-08T11:29:07.3542643-05:00",
"publishEnd": "2025-11-08T11:29:07.3542643-05:00",
"heading": "sample string 13",
"subheading": "sample string 14",
"localNotification": true,
"emailNotification": true,
"pushNotification": true
},
{
"mailID": "ac3c6ac5-8e94-4c3a-be38-a289af77141d",
"parentMailID": "74bb598a-2d43-47e7-9c10-daa96b220e82",
"fromUserID": 1,
"toUserID": 1,
"toOrganisationID": 1,
"priority": 3,
"flagged": true,
"opened": true,
"msgDate": "2025-11-08T11:29:07.3542643-05:00",
"msgType": 7,
"Message": "sample string 8",
"subject": "sample string 9",
"imageURL": "sample string 10",
"videoURL": "sample string 11",
"readDate": "2025-11-08T11:29:07.3542643-05:00",
"updated": "2025-11-08T11:29:07.3542643-05:00",
"cssClass": "sample string 12",
"published": true,
"publishStart": "2025-11-08T11:29:07.3542643-05:00",
"publishEnd": "2025-11-08T11:29:07.3542643-05:00",
"heading": "sample string 13",
"subheading": "sample string 14",
"localNotification": true,
"emailNotification": true,
"pushNotification": true
}
]
application/xml, text/xml
Sample:
<ArrayOfNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL.ClassroomCommon">
<Notification>
<Message>sample string 8</Message>
<cssClass>sample string 12</cssClass>
<emailNotification>true</emailNotification>
<flagged>true</flagged>
<fromUserID>1</fromUserID>
<heading>sample string 13</heading>
<imageURL>sample string 10</imageURL>
<localNotification>true</localNotification>
<mailID>ac3c6ac5-8e94-4c3a-be38-a289af77141d</mailID>
<msgDate>2025-11-08T11:29:07.3542643-05:00</msgDate>
<msgType>7</msgType>
<opened>true</opened>
<parentMailID>74bb598a-2d43-47e7-9c10-daa96b220e82</parentMailID>
<priority>3</priority>
<publishEnd>2025-11-08T11:29:07.3542643-05:00</publishEnd>
<publishStart>2025-11-08T11:29:07.3542643-05:00</publishStart>
<published>true</published>
<pushNotification>true</pushNotification>
<readDate>2025-11-08T11:29:07.3542643-05:00</readDate>
<subheading>sample string 14</subheading>
<subject>sample string 9</subject>
<toOrganisationID>1</toOrganisationID>
<toUserID>1</toUserID>
<updated>2025-11-08T11:29:07.3542643-05:00</updated>
<videoURL>sample string 11</videoURL>
</Notification>
<Notification>
<Message>sample string 8</Message>
<cssClass>sample string 12</cssClass>
<emailNotification>true</emailNotification>
<flagged>true</flagged>
<fromUserID>1</fromUserID>
<heading>sample string 13</heading>
<imageURL>sample string 10</imageURL>
<localNotification>true</localNotification>
<mailID>ac3c6ac5-8e94-4c3a-be38-a289af77141d</mailID>
<msgDate>2025-11-08T11:29:07.3542643-05:00</msgDate>
<msgType>7</msgType>
<opened>true</opened>
<parentMailID>74bb598a-2d43-47e7-9c10-daa96b220e82</parentMailID>
<priority>3</priority>
<publishEnd>2025-11-08T11:29:07.3542643-05:00</publishEnd>
<publishStart>2025-11-08T11:29:07.3542643-05:00</publishStart>
<published>true</published>
<pushNotification>true</pushNotification>
<readDate>2025-11-08T11:29:07.3542643-05:00</readDate>
<subheading>sample string 14</subheading>
<subject>sample string 9</subject>
<toOrganisationID>1</toOrganisationID>
<toUserID>1</toUserID>
<updated>2025-11-08T11:29:07.3542643-05:00</updated>
<videoURL>sample string 11</videoURL>
</Notification>
</ArrayOfNotification>