GET restapi/personal/studentplan/courses/v1?lastCommentReadDateTimesUtc={lastCommentReadDateTimesUtc}

Returns a list of courses for the Student Plan.

Request Information

URI Parameters

Name	Description	Type	Additional information
lastCommentReadDateTimesUtc	Comma separated date and time when comments has been last read for each course in the following format: "{courseId}.{date}".	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Itslearning.RestApi.Entities.StudentPlan.StudentPlanCourse

Name	Description	Type	Additional information
Id	The course identifier.	integer	None.
Title	Title of the course.	string	None.
Color	The course selected color.	string	None.
NumberOfAssignedAchievementGoals	The number of assigned achievement goals.	integer	None.
NumberOfUnreadComments	The number of unread comments.	integer	None.
IsEmpty	Flag indicating that student plan is empty (i.e. no comments, assessments or goals) for the course.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Title": "sample string 2",
    "Color": "sample string 3",
    "NumberOfAssignedAchievementGoals": 4,
    "NumberOfUnreadComments": 5,
    "IsEmpty": true
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Color": "sample string 3",
    "NumberOfAssignedAchievementGoals": 4,
    "NumberOfUnreadComments": 5,
    "IsEmpty": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfStudentPlanCourse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <StudentPlanCourse>
    <Color>sample string 3</Color>
    <Id>1</Id>
    <IsEmpty>true</IsEmpty>
    <NumberOfAssignedAchievementGoals>4</NumberOfAssignedAchievementGoals>
    <NumberOfUnreadComments>5</NumberOfUnreadComments>
    <Title>sample string 2</Title>
  </StudentPlanCourse>
  <StudentPlanCourse>
    <Color>sample string 3</Color>
    <Id>1</Id>
    <IsEmpty>true</IsEmpty>
    <NumberOfAssignedAchievementGoals>4</NumberOfAssignedAchievementGoals>
    <NumberOfUnreadComments>5</NumberOfUnreadComments>
    <Title>sample string 2</Title>
  </StudentPlanCourse>
</ArrayOfStudentPlanCourse>