GET restapi/personal/studentplan/comments/v1?courseId={courseId}&UseNewerThan={UseNewerThan}&FromId={FromId}&PageIndex={PageIndex}&PageSize={PageSize}

Retrieves a list of comments that relates to specific person student plan.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
courseId

The course identifier.

integer

Required

UseNewerThan

boolean

None.

FromId

integer

None.

PageIndex

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Itslearning.RestApi.Entities.StudentPlan.Comments.StudentPlanComment
NameDescriptionTypeAdditional information
Id

Comment identifier.

integer

None.

SourceId

The identifier of source entity that comment belongs to.

integer

None.

SourceType

The type of source identifier that comment belongs to.

string

None.

PictureUrl

Url of the person picture.

string

None.

UserName

Name of user who created the comment.

string

None.

CommentText

Text message.

string

None.

PublishedDateTime

Date and time when comment was published.

date

None.

LastModifiedDateTime

Date and time when comment was last modified.

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "SourceId": 2,
    "SourceType": "sample string 3",
    "PictureUrl": "sample string 4",
    "UserName": "sample string 5",
    "CommentText": "sample string 6",
    "PublishedDateTime": "2025-06-25T13:21:02Z",
    "LastModifiedDateTime": "2025-06-25T13:21:02Z"
  },
  {
    "Id": 1,
    "SourceId": 2,
    "SourceType": "sample string 3",
    "PictureUrl": "sample string 4",
    "UserName": "sample string 5",
    "CommentText": "sample string 6",
    "PublishedDateTime": "2025-06-25T13:21:02Z",
    "LastModifiedDateTime": "2025-06-25T13:21:02Z"
  }
]

application/xml, text/xml

Sample:
<ArrayOfStudentPlanComment xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <StudentPlanComment>
    <CommentText>sample string 6</CommentText>
    <Id>1</Id>
    <LastModifiedDateTime>2025-06-25T13:21:02Z</LastModifiedDateTime>
    <PictureUrl>sample string 4</PictureUrl>
    <PublishedDateTime>2025-06-25T13:21:02Z</PublishedDateTime>
    <SourceId>2</SourceId>
    <SourceType>sample string 3</SourceType>
    <UserName>sample string 5</UserName>
  </StudentPlanComment>
  <StudentPlanComment>
    <CommentText>sample string 6</CommentText>
    <Id>1</Id>
    <LastModifiedDateTime>2025-06-25T13:21:02Z</LastModifiedDateTime>
    <PictureUrl>sample string 4</PictureUrl>
    <PublishedDateTime>2025-06-25T13:21:02Z</PublishedDateTime>
    <SourceId>2</SourceId>
    <SourceType>sample string 3</SourceType>
    <UserName>sample string 5</UserName>
  </StudentPlanComment>
</ArrayOfStudentPlanComment>