GET request/notification

Displays the Users Notifications Details

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Notification
NameDescriptionTypeAdditional information
Read

Collection of NotificationView

None.

Unread

Collection of NotificationView

None.

Response Formats

application/json, text/json

Sample:
{
  "read": [
    {
      "id": 1,
      "title": "sample string 2",
      "text": "sample string 3",
      "notificationTypeId": 4,
      "isRead": true,
      "expiryDate": "2025-06-29T02:00:10.4508267+00:00"
    },
    {
      "id": 1,
      "title": "sample string 2",
      "text": "sample string 3",
      "notificationTypeId": 4,
      "isRead": true,
      "expiryDate": "2025-06-29T02:00:10.4508267+00:00"
    }
  ],
  "unread": [
    {
      "id": 1,
      "title": "sample string 2",
      "text": "sample string 3",
      "notificationTypeId": 4,
      "isRead": true,
      "expiryDate": "2025-06-29T02:00:10.4508267+00:00"
    },
    {
      "id": 1,
      "title": "sample string 2",
      "text": "sample string 3",
      "notificationTypeId": 4,
      "isRead": true,
      "expiryDate": "2025-06-29T02:00:10.4508267+00:00"
    }
  ]
}

text/html

Sample:
{"read":[{"id":1,"title":"sample string 2","text":"sample string 3","notificationTypeId":4,"isRead":true,"expiryDate":"2025-06-29T02:00:10.4508267+00:00"},{"id":1,"title":"sample string 2","text":"sample string 3","notificationTypeId":4,"isRead":true,"expiryDate":"2025-06-29T02:00:10.4508267+00:00"}],"unread":[{"id":1,"title":"sample string 2","text":"sample string 3","notificationTypeId":4,"isRead":true,"expiryDate":"2025-06-29T02:00:10.4508267+00:00"},{"id":1,"title":"sample string 2","text":"sample string 3","notificationTypeId":4,"isRead":true,"expiryDate":"2025-06-29T02:00:10.4508267+00:00"}]}

application/xml, text/xml

Sample:
<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Dashboard">
  <Read>
    <NotificationView>
      <ExpiryDate>2025-06-29T02:00:10.4508267+00:00</ExpiryDate>
      <IsRead>true</IsRead>
      <NotificationTypeId>4</NotificationTypeId>
      <Text>sample string 3</Text>
      <Title>sample string 2</Title>
      <Id>1</Id>
    </NotificationView>
    <NotificationView>
      <ExpiryDate>2025-06-29T02:00:10.4508267+00:00</ExpiryDate>
      <IsRead>true</IsRead>
      <NotificationTypeId>4</NotificationTypeId>
      <Text>sample string 3</Text>
      <Title>sample string 2</Title>
      <Id>1</Id>
    </NotificationView>
  </Read>
  <Unread>
    <NotificationView>
      <ExpiryDate>2025-06-29T02:00:10.4508267+00:00</ExpiryDate>
      <IsRead>true</IsRead>
      <NotificationTypeId>4</NotificationTypeId>
      <Text>sample string 3</Text>
      <Title>sample string 2</Title>
      <Id>1</Id>
    </NotificationView>
    <NotificationView>
      <ExpiryDate>2025-06-29T02:00:10.4508267+00:00</ExpiryDate>
      <IsRead>true</IsRead>
      <NotificationTypeId>4</NotificationTypeId>
      <Text>sample string 3</Text>
      <Title>sample string 2</Title>
      <Id>1</Id>
    </NotificationView>
  </Unread>
</Notification>