GET restapi/personal/courses/{courseId}/stream/v1?showLightBulletins={showLightBulletins}&UseNewerThan={UseNewerThan}&FromId={FromId}&PageIndex={PageIndex}&PageSize={PageSize}
Gets user's stream feed, which is collected from the course.
If no parameters specified, 100 latest items will be returned.
The client can specify paging with a combination of UseNewerThan and FromId to be able to page directly from a specified NotificationId. Due to the fact that stream items are sorted by PublishedDate (not by ID), it's required to specify FromId parameter. Both should belong to a single StreamItem entity. By default, items older than specified are returned, but it's possible to override that behavior by setting UseNewerThan to true.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
courseId |
Error if courseId equals 0The Course ID for the requested course |
integer |
Required |
showLightBulletins |
If True returns stream with light bulletins. |
boolean |
Default value is True |
UseNewerThan | boolean |
None. |
|
FromId | integer |
None. |
|
PageIndex | integer |
None. |
|
PageSize | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
The collection of StreamItems for the course.
EntityListOfItslearning.RestApi.Entities.StreamItemV2Name | Description | Type | Additional information |
---|---|---|---|
EntityArray | Collection of Itslearning.RestApi.Entities.StreamItemV2 |
None. |
|
Total | integer |
None. |
|
CurrentPageIndex | integer |
None. |
|
PageSize | integer |
None. |
Response Formats
application/json, text/json
{ "EntityArray": [ { "NotificationId": 1, "Text": "sample string 2", "LocationTitle": "sample string 3", "PublishedDate": "2025-06-17T10:04:54Z", "PublishedBy": { "PersonId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "FullName": "sample string 4", "ProfileUrl": "sample string 5", "AdditionalInfo": "sample string 6", "ProfileImageUrl": "sample string 7", "ProfileImageUrlSmall": "sample string 8" }, "Url": "sample string 5", "ContentUrl": "sample string 6", "IconUrl": "sample string 7", "LightBulletin": { "LightBulletinId": 1, "Text": "sample string 2", "EmbedUrl": "sample string 3", "Pinned": true, "AllowComments": true, "HasResources": true, "AttachedImages": [ { "PreviewFileId": 1, "PreviewFileUrl": "sample string 2", "OriginalFileId": 3, "OriginalFileUrl": "sample string 4" }, { "PreviewFileId": 1, "PreviewFileUrl": "sample string 2", "OriginalFileId": 3, "OriginalFileUrl": "sample string 4" } ], "ResourcesCount": 7, "CommentsCount": 8, "ActiveFromDate": "2025-06-17T10:04:54Z", "ActiveToDate": "2025-06-17T10:04:54Z", "IsSubscribed": true, "PublishedDate": "2025-06-17T10:04:54Z", "PublishedBy": { "PersonId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "FullName": "sample string 4", "ProfileUrl": "sample string 5", "AdditionalInfo": "sample string 6", "ProfileImageUrl": "sample string 7", "ProfileImageUrlSmall": "sample string 8" } }, "ElementId": 8, "ElementType": "Unknown", "LearningToolId": 9, "HasMoreElements": true, "ElementsCount": 11, "LocationType": "Course", "LocationId": 1 }, { "NotificationId": 1, "Text": "sample string 2", "LocationTitle": "sample string 3", "PublishedDate": "2025-06-17T10:04:54Z", "PublishedBy": { "PersonId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "FullName": "sample string 4", "ProfileUrl": "sample string 5", "AdditionalInfo": "sample string 6", "ProfileImageUrl": "sample string 7", "ProfileImageUrlSmall": "sample string 8" }, "Url": "sample string 5", "ContentUrl": "sample string 6", "IconUrl": "sample string 7", "LightBulletin": { "LightBulletinId": 1, "Text": "sample string 2", "EmbedUrl": "sample string 3", "Pinned": true, "AllowComments": true, "HasResources": true, "AttachedImages": [ { "PreviewFileId": 1, "PreviewFileUrl": "sample string 2", "OriginalFileId": 3, "OriginalFileUrl": "sample string 4" }, { "PreviewFileId": 1, "PreviewFileUrl": "sample string 2", "OriginalFileId": 3, "OriginalFileUrl": "sample string 4" } ], "ResourcesCount": 7, "CommentsCount": 8, "ActiveFromDate": "2025-06-17T10:04:54Z", "ActiveToDate": "2025-06-17T10:04:54Z", "IsSubscribed": true, "PublishedDate": "2025-06-17T10:04:54Z", "PublishedBy": { "PersonId": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "FullName": "sample string 4", "ProfileUrl": "sample string 5", "AdditionalInfo": "sample string 6", "ProfileImageUrl": "sample string 7", "ProfileImageUrlSmall": "sample string 8" } }, "ElementId": 8, "ElementType": "Unknown", "LearningToolId": 9, "HasMoreElements": true, "ElementsCount": 11, "LocationType": "Course", "LocationId": 1 } ], "Total": 1, "CurrentPageIndex": 2, "PageSize": 3 }
application/xml, text/xml
<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CurrentPageIndex>2</CurrentPageIndex> <EntityArray> <StreamItemV2> <ContentUrl>sample string 6</ContentUrl> <ElementId>8</ElementId> <ElementType>Unknown</ElementType> <ElementsCount>11</ElementsCount> <HasMoreElements>true</HasMoreElements> <IconUrl>sample string 7</IconUrl> <LearningToolId>9</LearningToolId> <LightBulletin> <ActiveFromDate>2025-06-17T10:04:54Z</ActiveFromDate> <ActiveToDate>2025-06-17T10:04:54Z</ActiveToDate> <AllowComments>true</AllowComments> <AttachedImages> <LightBulletinImage> <OriginalFileId>3</OriginalFileId> <OriginalFileUrl>sample string 4</OriginalFileUrl> <PreviewFileId>1</PreviewFileId> <PreviewFileUrl>sample string 2</PreviewFileUrl> </LightBulletinImage> <LightBulletinImage> <OriginalFileId>3</OriginalFileId> <OriginalFileUrl>sample string 4</OriginalFileUrl> <PreviewFileId>1</PreviewFileId> <PreviewFileUrl>sample string 2</PreviewFileUrl> </LightBulletinImage> </AttachedImages> <CommentsCount>8</CommentsCount> <EmbedUrl>sample string 3</EmbedUrl> <HasResources>true</HasResources> <IsSubscribed>true</IsSubscribed> <LightBulletinId>1</LightBulletinId> <Pinned>true</Pinned> <PublishedBy> <AdditionalInfo>sample string 6</AdditionalInfo> <FirstName>sample string 2</FirstName> <FullName>sample string 4</FullName> <LastName>sample string 3</LastName> <PersonId>1</PersonId> <ProfileImageUrl>sample string 7</ProfileImageUrl> <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall> <ProfileUrl>sample string 5</ProfileUrl> </PublishedBy> <PublishedDate>2025-06-17T10:04:54Z</PublishedDate> <ResourcesCount>7</ResourcesCount> <Text>sample string 2</Text> </LightBulletin> <LocationId>1</LocationId> <LocationTitle>sample string 3</LocationTitle> <LocationType>Course</LocationType> <NotificationId>1</NotificationId> <PublishedBy> <AdditionalInfo>sample string 6</AdditionalInfo> <FirstName>sample string 2</FirstName> <FullName>sample string 4</FullName> <LastName>sample string 3</LastName> <PersonId>1</PersonId> <ProfileImageUrl>sample string 7</ProfileImageUrl> <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall> <ProfileUrl>sample string 5</ProfileUrl> </PublishedBy> <PublishedDate>2025-06-17T10:04:54Z</PublishedDate> <Text>sample string 2</Text> <Url>sample string 5</Url> </StreamItemV2> <StreamItemV2> <ContentUrl>sample string 6</ContentUrl> <ElementId>8</ElementId> <ElementType>Unknown</ElementType> <ElementsCount>11</ElementsCount> <HasMoreElements>true</HasMoreElements> <IconUrl>sample string 7</IconUrl> <LearningToolId>9</LearningToolId> <LightBulletin> <ActiveFromDate>2025-06-17T10:04:54Z</ActiveFromDate> <ActiveToDate>2025-06-17T10:04:54Z</ActiveToDate> <AllowComments>true</AllowComments> <AttachedImages> <LightBulletinImage> <OriginalFileId>3</OriginalFileId> <OriginalFileUrl>sample string 4</OriginalFileUrl> <PreviewFileId>1</PreviewFileId> <PreviewFileUrl>sample string 2</PreviewFileUrl> </LightBulletinImage> <LightBulletinImage> <OriginalFileId>3</OriginalFileId> <OriginalFileUrl>sample string 4</OriginalFileUrl> <PreviewFileId>1</PreviewFileId> <PreviewFileUrl>sample string 2</PreviewFileUrl> </LightBulletinImage> </AttachedImages> <CommentsCount>8</CommentsCount> <EmbedUrl>sample string 3</EmbedUrl> <HasResources>true</HasResources> <IsSubscribed>true</IsSubscribed> <LightBulletinId>1</LightBulletinId> <Pinned>true</Pinned> <PublishedBy> <AdditionalInfo>sample string 6</AdditionalInfo> <FirstName>sample string 2</FirstName> <FullName>sample string 4</FullName> <LastName>sample string 3</LastName> <PersonId>1</PersonId> <ProfileImageUrl>sample string 7</ProfileImageUrl> <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall> <ProfileUrl>sample string 5</ProfileUrl> </PublishedBy> <PublishedDate>2025-06-17T10:04:54Z</PublishedDate> <ResourcesCount>7</ResourcesCount> <Text>sample string 2</Text> </LightBulletin> <LocationId>1</LocationId> <LocationTitle>sample string 3</LocationTitle> <LocationType>Course</LocationType> <NotificationId>1</NotificationId> <PublishedBy> <AdditionalInfo>sample string 6</AdditionalInfo> <FirstName>sample string 2</FirstName> <FullName>sample string 4</FullName> <LastName>sample string 3</LastName> <PersonId>1</PersonId> <ProfileImageUrl>sample string 7</ProfileImageUrl> <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall> <ProfileUrl>sample string 5</ProfileUrl> </PublishedBy> <PublishedDate>2025-06-17T10:04:54Z</PublishedDate> <Text>sample string 2</Text> <Url>sample string 5</Url> </StreamItemV2> </EntityArray> <PageSize>3</PageSize> <Total>1</Total> </EntityList>