GET restapi/personal/courses/{courseId}/calendarevents/v1?PageIndex={PageIndex}&PageSize={PageSize}&fromDate={fromDate}&toDate={toDate}
Gets the calendar events for the given course.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| courseId |
The course identifier. |
integer |
Required |
| PageIndex | integer |
None. |
|
| PageSize | integer |
None. |
|
| fromDate |
From date for filtering calendar events. |
date |
None. |
| toDate |
To date for filtering calendar events. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
EntityListOfItslearning.RestApi.Entities.Personal.CalendarEvent| Name | Description | Type | Additional information |
|---|---|---|---|
| EntityArray | Collection of Itslearning.RestApi.Entities.Personal.CalendarEvent |
None. |
|
| Total | integer |
None. |
|
| CurrentPageIndex | integer |
None. |
|
| PageSize | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"EntityArray": [
{
"Id": 1,
"FromDate": "2025-10-23T16:53:54Z",
"ToDate": "2025-10-23T16:53:54Z",
"EventTitle": "sample string 4",
"Description": "sample string 5",
"ImportDescription": "sample string 6",
"CourseId": 7,
"CourseGroupId": 8,
"LocationColor": "sample string 9",
"LocationFillColor": "sample string 10",
"LocationTitle": "sample string 11",
"LocationFriendlyName": "sample string 12",
"AttendanceDetails": {
"KeepAttendancePageUrl": "sample string 1",
"AttendanceStatistics": {
"Present": 1,
"Absent": 2,
"Excluded": 3
}
}
},
{
"Id": 1,
"FromDate": "2025-10-23T16:53:54Z",
"ToDate": "2025-10-23T16:53:54Z",
"EventTitle": "sample string 4",
"Description": "sample string 5",
"ImportDescription": "sample string 6",
"CourseId": 7,
"CourseGroupId": 8,
"LocationColor": "sample string 9",
"LocationFillColor": "sample string 10",
"LocationTitle": "sample string 11",
"LocationFriendlyName": "sample string 12",
"AttendanceDetails": {
"KeepAttendancePageUrl": "sample string 1",
"AttendanceStatistics": {
"Present": 1,
"Absent": 2,
"Excluded": 3
}
}
}
],
"Total": 1,
"CurrentPageIndex": 2,
"PageSize": 3
}
application/xml, text/xml
Sample:
<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CurrentPageIndex>2</CurrentPageIndex>
<EntityArray>
<CalendarEvent>
<AttendanceDetails>
<AttendanceStatistics>
<Absent>2</Absent>
<Excluded>3</Excluded>
<Present>1</Present>
</AttendanceStatistics>
<KeepAttendancePageUrl>sample string 1</KeepAttendancePageUrl>
</AttendanceDetails>
<CourseGroupId>8</CourseGroupId>
<CourseId>7</CourseId>
<Description>sample string 5</Description>
<EventTitle>sample string 4</EventTitle>
<FromDate>2025-10-23T16:53:54Z</FromDate>
<Id>1</Id>
<ImportDescription>sample string 6</ImportDescription>
<LocationColor>sample string 9</LocationColor>
<LocationFillColor>sample string 10</LocationFillColor>
<LocationFriendlyName>sample string 12</LocationFriendlyName>
<LocationTitle>sample string 11</LocationTitle>
<ToDate>2025-10-23T16:53:54Z</ToDate>
</CalendarEvent>
<CalendarEvent>
<AttendanceDetails>
<AttendanceStatistics>
<Absent>2</Absent>
<Excluded>3</Excluded>
<Present>1</Present>
</AttendanceStatistics>
<KeepAttendancePageUrl>sample string 1</KeepAttendancePageUrl>
</AttendanceDetails>
<CourseGroupId>8</CourseGroupId>
<CourseId>7</CourseId>
<Description>sample string 5</Description>
<EventTitle>sample string 4</EventTitle>
<FromDate>2025-10-23T16:53:54Z</FromDate>
<Id>1</Id>
<ImportDescription>sample string 6</ImportDescription>
<LocationColor>sample string 9</LocationColor>
<LocationFillColor>sample string 10</LocationFillColor>
<LocationFriendlyName>sample string 12</LocationFriendlyName>
<LocationTitle>sample string 11</LocationTitle>
<ToDate>2025-10-23T16:53:54Z</ToDate>
</CalendarEvent>
</EntityArray>
<PageSize>3</PageSize>
<Total>1</Total>
</EntityList>