Help Page Home

Notifications

GET v1/my/notifications

Gets a page of the user's Notifications.

Request Information

URI Parameters

None.

Body Parameters

None.

Request Formats

Sample:
GET /v1/my/notifications
Accept: application/json
Authorization: Bearer VSo3gOu-X7nimE0xcav8ftN_Cb0aAOKeNIdR88K ...
Host: testapi.codeproject.com
Pragma: no-cache
Sample:
GET /v1/my/notifications
Accept: application/xml
Authorization: Bearer VSo3gOu-X7nimE0xcav8ftN_Cb0aAOKeNIdR88K ...
Host: testapi.codeproject.com
Pragma: no-cache

Response Information

Resource Description

A page of the user's unread Notifications in reverse chronological order(?).

MyNotificationsViewModel
NameDescriptionTypeAdditional information
Notifications

Gets or sets the collection of NotificationViewModels.

Collection of NotificationViewModel

None.

Response Formats

Sample:
{
  "notifications": [
    {
      "id": 1,
      "objectTypeName": "sample string 2",
      "objectId": 3,
      "subject": "sample string 4",
      "topic": "sample string 5",
      "notificationDate": "2018-04-20T23:34:47.1743426-04:00",
      "unRead": true,
      "content": "sample string 8",
      "link": "sample string 9"
    },
    {
      "id": 1,
      "objectTypeName": "sample string 2",
      "objectId": 3,
      "subject": "sample string 4",
      "topic": "sample string 5",
      "notificationDate": "2018-04-20T23:34:47.1743426-04:00",
      "unRead": true,
      "content": "sample string 8",
      "link": "sample string 9"
    }
  ]
}
Sample:
<MyNotificationsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodeProject.WebApi.Models">
  <Notifications>
    <NotificationViewModel>
      <Content>sample string 8</Content>
      <Link>sample string 9</Link>
      <NotificationDate>2018-04-20T23:34:47.1743426-04:00</NotificationDate>
      <ObjectId>3</ObjectId>
      <ObjectTypeName>sample string 2</ObjectTypeName>
      <Subject>sample string 4</Subject>
      <Topic>sample string 5</Topic>
      <UnRead>true</UnRead>
    </NotificationViewModel>
    <NotificationViewModel>
      <Content>sample string 8</Content>
      <Link>sample string 9</Link>
      <NotificationDate>2018-04-20T23:34:47.1743426-04:00</NotificationDate>
      <ObjectId>3</ObjectId>
      <ObjectTypeName>sample string 2</ObjectTypeName>
      <Subject>sample string 4</Subject>
      <Topic>sample string 5</Topic>
      <UnRead>true</UnRead>
    </NotificationViewModel>
  </Notifications>
</MyNotificationsViewModel>