GET api/v3/Notifications/NotificationsHistory?pagenum={pagenum}&pagesize={pagesize}

Request Information

URI Parameters

Name	Description	Type	Additional information
pagenum		integer	Default value is 0
pagesize		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

PushNotificationHistory

Name	Type	Additional information
ShotClassNotification	Collection of ShotClassNotifications	None.
PollNotifications	Collection of PollNotifications	None.
EngagementCenter	Collection of EngagementCenter	None.
ForumNotifications	ForumNotifications	None.
ProgramUpdateNotifications	Collection of ProgramUpdateNotification	None.
TotalNotifications	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ShotClassNotification": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "ImageURL": "sample string 3",
      "KeyLearning": "sample string 4",
      "ShotClassTypeId": 5,
      "TenantId": 6,
      "NotifiedBy": 7,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "NotifiedUser": 9,
      "ShortMessage": "sample string 10",
      "MediaType": 11
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ImageURL": "sample string 3",
      "KeyLearning": "sample string 4",
      "ShotClassTypeId": 5,
      "TenantId": 6,
      "NotifiedBy": 7,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "NotifiedUser": 9,
      "ShortMessage": "sample string 10",
      "MediaType": 11
    }
  ],
  "PollNotifications": [
    {
      "ID": 1,
      "PollQuestion": "sample string 2",
      "CreatedOn": "sample string 3",
      "TenantId": 4,
      "NotifiedBy": 5,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "ShortMessage": "sample string 7",
      "NotifiedUser": 8,
      "PollExpiryDate": "2024-09-06T11:19:43.5381865Z",
      "IsResponded": true,
      "DistributionId": 11,
      "PollDefaultImgUrl": "sample string 12"
    },
    {
      "ID": 1,
      "PollQuestion": "sample string 2",
      "CreatedOn": "sample string 3",
      "TenantId": 4,
      "NotifiedBy": 5,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "ShortMessage": "sample string 7",
      "NotifiedUser": 8,
      "PollExpiryDate": "2024-09-06T11:19:43.5381865Z",
      "IsResponded": true,
      "DistributionId": 11,
      "PollDefaultImgUrl": "sample string 12"
    }
  ],
  "EngagementCenter": [
    {
      "Id": 1,
      "TrackingId": "sample string 2",
      "NotifiedUser": 3,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "TenantId": 5,
      "Payload": "sample string 6",
      "IsUserAware": true,
      "IsResponded": true,
      "UserChoiceText": "sample string 9",
      "IconImageUrl": "sample string 10"
    },
    {
      "Id": 1,
      "TrackingId": "sample string 2",
      "NotifiedUser": 3,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "TenantId": 5,
      "Payload": "sample string 6",
      "IsUserAware": true,
      "IsResponded": true,
      "UserChoiceText": "sample string 9",
      "IconImageUrl": "sample string 10"
    }
  ],
  "ForumNotifications": {},
  "ProgramUpdateNotifications": [
    {
      "Id": 1,
      "ProgramId": 2,
      "ShotclassId": 3,
      "ImageURL": "sample string 4",
      "ShotclassName": "sample string 5",
      "ShotclassOverview": "sample string 6",
      "ShotclassDescription": "sample string 7",
      "VideoDuration": "00:00:00.1234567",
      "TenantId": 9,
      "NotifiedBy": 10,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "NotifiedUser": 12,
      "IsRead": true,
      "Status": true
    },
    {
      "Id": 1,
      "ProgramId": 2,
      "ShotclassId": 3,
      "ImageURL": "sample string 4",
      "ShotclassName": "sample string 5",
      "ShotclassOverview": "sample string 6",
      "ShotclassDescription": "sample string 7",
      "VideoDuration": "00:00:00.1234567",
      "TenantId": 9,
      "NotifiedBy": 10,
      "NotifiedDate": "2024-09-06T11:19:43.5381865Z",
      "NotifiedUser": 12,
      "IsRead": true,
      "Status": true
    }
  ],
  "TotalNotifications": 1
}

text/html

Sample:

{"ShotClassNotification":[{"Id":1,"Name":"sample string 2","ImageURL":"sample string 3","KeyLearning":"sample string 4","ShotClassTypeId":5,"TenantId":6,"NotifiedBy":7,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","NotifiedUser":9,"ShortMessage":"sample string 10","MediaType":11},{"Id":1,"Name":"sample string 2","ImageURL":"sample string 3","KeyLearning":"sample string 4","ShotClassTypeId":5,"TenantId":6,"NotifiedBy":7,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","NotifiedUser":9,"ShortMessage":"sample string 10","MediaType":11}],"PollNotifications":[{"ID":1,"PollQuestion":"sample string 2","CreatedOn":"sample string 3","TenantId":4,"NotifiedBy":5,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","ShortMessage":"sample string 7","NotifiedUser":8,"PollExpiryDate":"2024-09-06T11:19:43.5381865Z","IsResponded":true,"DistributionId":11,"PollDefaultImgUrl":"sample string 12"},{"ID":1,"PollQuestion":"sample string 2","CreatedOn":"sample string 3","TenantId":4,"NotifiedBy":5,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","ShortMessage":"sample string 7","NotifiedUser":8,"PollExpiryDate":"2024-09-06T11:19:43.5381865Z","IsResponded":true,"DistributionId":11,"PollDefaultImgUrl":"sample string 12"}],"EngagementCenter":[{"Id":1,"TrackingId":"sample string 2","NotifiedUser":3,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","TenantId":5,"Payload":"sample string 6","IsUserAware":true,"IsResponded":true,"UserChoiceText":"sample string 9","IconImageUrl":"sample string 10"},{"Id":1,"TrackingId":"sample string 2","NotifiedUser":3,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","TenantId":5,"Payload":"sample string 6","IsUserAware":true,"IsResponded":true,"UserChoiceText":"sample string 9","IconImageUrl":"sample string 10"}],"ForumNotifications":{},"ProgramUpdateNotifications":[{"Id":1,"ProgramId":2,"ShotclassId":3,"ImageURL":"sample string 4","ShotclassName":"sample string 5","ShotclassOverview":"sample string 6","ShotclassDescription":"sample string 7","VideoDuration":"00:00:00.1234567","TenantId":9,"NotifiedBy":10,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","NotifiedUser":12,"IsRead":true,"Status":true},{"Id":1,"ProgramId":2,"ShotclassId":3,"ImageURL":"sample string 4","ShotclassName":"sample string 5","ShotclassOverview":"sample string 6","ShotclassDescription":"sample string 7","VideoDuration":"00:00:00.1234567","TenantId":9,"NotifiedBy":10,"NotifiedDate":"2024-09-06T11:19:43.5381865Z","NotifiedUser":12,"IsRead":true,"Status":true}],"TotalNotifications":1}

text/xml

Sample:

<PushNotificationHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShotClassCore.Models">
  <EngagementCenter>
    <EngagementCenter>
      <IconImageUrl>sample string 10</IconImageUrl>
      <Id>1</Id>
      <IsResponded>true</IsResponded>
      <IsUserAware>true</IsUserAware>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>3</NotifiedUser>
      <Payload>sample string 6</Payload>
      <TenantId>5</TenantId>
      <TrackingId>sample string 2</TrackingId>
      <UserChoiceText>sample string 9</UserChoiceText>
    </EngagementCenter>
    <EngagementCenter>
      <IconImageUrl>sample string 10</IconImageUrl>
      <Id>1</Id>
      <IsResponded>true</IsResponded>
      <IsUserAware>true</IsUserAware>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>3</NotifiedUser>
      <Payload>sample string 6</Payload>
      <TenantId>5</TenantId>
      <TrackingId>sample string 2</TrackingId>
      <UserChoiceText>sample string 9</UserChoiceText>
    </EngagementCenter>
  </EngagementCenter>
  <ForumNotifications />
  <PollNotifications>
    <PollNotifications>
      <CreatedOn>sample string 3</CreatedOn>
      <DistributionId>11</DistributionId>
      <ID>1</ID>
      <IsResponded>true</IsResponded>
      <NotifiedBy>5</NotifiedBy>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>8</NotifiedUser>
      <PollDefaultImgUrl>sample string 12</PollDefaultImgUrl>
      <PollExpiryDate>2024-09-06T11:19:43.5381865Z</PollExpiryDate>
      <PollQuestion>sample string 2</PollQuestion>
      <ShortMessage>sample string 7</ShortMessage>
      <TenantId>4</TenantId>
    </PollNotifications>
    <PollNotifications>
      <CreatedOn>sample string 3</CreatedOn>
      <DistributionId>11</DistributionId>
      <ID>1</ID>
      <IsResponded>true</IsResponded>
      <NotifiedBy>5</NotifiedBy>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>8</NotifiedUser>
      <PollDefaultImgUrl>sample string 12</PollDefaultImgUrl>
      <PollExpiryDate>2024-09-06T11:19:43.5381865Z</PollExpiryDate>
      <PollQuestion>sample string 2</PollQuestion>
      <ShortMessage>sample string 7</ShortMessage>
      <TenantId>4</TenantId>
    </PollNotifications>
  </PollNotifications>
  <ProgramUpdateNotifications>
    <ProgramUpdateNotification>
      <Id>1</Id>
      <ImageURL>sample string 4</ImageURL>
      <IsRead>true</IsRead>
      <NotifiedBy>10</NotifiedBy>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>12</NotifiedUser>
      <ProgramId>2</ProgramId>
      <ShotclassDescription>sample string 7</ShotclassDescription>
      <ShotclassId>3</ShotclassId>
      <ShotclassName>sample string 5</ShotclassName>
      <ShotclassOverview>sample string 6</ShotclassOverview>
      <Status>true</Status>
      <TenantId>9</TenantId>
      <VideoDuration>PT0.1234567S</VideoDuration>
    </ProgramUpdateNotification>
    <ProgramUpdateNotification>
      <Id>1</Id>
      <ImageURL>sample string 4</ImageURL>
      <IsRead>true</IsRead>
      <NotifiedBy>10</NotifiedBy>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>12</NotifiedUser>
      <ProgramId>2</ProgramId>
      <ShotclassDescription>sample string 7</ShotclassDescription>
      <ShotclassId>3</ShotclassId>
      <ShotclassName>sample string 5</ShotclassName>
      <ShotclassOverview>sample string 6</ShotclassOverview>
      <Status>true</Status>
      <TenantId>9</TenantId>
      <VideoDuration>PT0.1234567S</VideoDuration>
    </ProgramUpdateNotification>
  </ProgramUpdateNotifications>
  <ShotClassNotification>
    <ShotClassNotifications>
      <Id>1</Id>
      <ImageURL>sample string 3</ImageURL>
      <KeyLearning>sample string 4</KeyLearning>
      <MediaType>11</MediaType>
      <Name>sample string 2</Name>
      <NotifiedBy>7</NotifiedBy>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>9</NotifiedUser>
      <ShortMessage>sample string 10</ShortMessage>
      <ShotClassTypeId>5</ShotClassTypeId>
      <TenantId>6</TenantId>
    </ShotClassNotifications>
    <ShotClassNotifications>
      <Id>1</Id>
      <ImageURL>sample string 3</ImageURL>
      <KeyLearning>sample string 4</KeyLearning>
      <MediaType>11</MediaType>
      <Name>sample string 2</Name>
      <NotifiedBy>7</NotifiedBy>
      <NotifiedDate>2024-09-06T11:19:43.5381865Z</NotifiedDate>
      <NotifiedUser>9</NotifiedUser>
      <ShortMessage>sample string 10</ShortMessage>
      <ShotClassTypeId>5</ShotClassTypeId>
      <TenantId>6</TenantId>
    </ShotClassNotifications>
  </ShotClassNotification>
  <TotalNotifications>1</TotalNotifications>
</PushNotificationHistory>