GET restapi/personal/studentplan/overview/v1?courseId={courseId}&lastCommentReadDateTimeUtc={lastCommentReadDateTimeUtc}

Returns an overview entity for the Student Plan.

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The course identifier.	integer	Required
lastCommentReadDateTimeUtc	Date and time when comments has been last read.	date	None.

Body Parameters

None.

Response Information

Resource Description

Itslearning.RestApi.Entities.StudentPlan.StudentPlanOverview

Name	Description	Type	Additional information
AssessmentsError	Error state for the assessments.	Itslearning.RestApi.Entities.StudentPlan.AssessmentsErrorType	None.
CourseColor	The course color.	string	None.
CourseTitle	The course title.	string	None.
UnreadCommentsCount	Number of unread comments for the current person.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AssessmentsError": "None",
  "CourseColor": "sample string 1",
  "CourseTitle": "sample string 2",
  "UnreadCommentsCount": 3
}

application/xml, text/xml

Sample:

<StudentPlanOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssessmentsError>None</AssessmentsError>
  <CourseColor>sample string 1</CourseColor>
  <CourseTitle>sample string 2</CourseTitle>
  <UnreadCommentsCount>3</UnreadCommentsCount>
</StudentPlanOverview>