GET restapi/personal/children/{childId}/courses/{courseId}/events/v1?fromDate={fromDate}&toDate={toDate}&PageIndex={PageIndex}&PageSize={PageSize}

Gets a list of calendar events for the child in course.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
childId

[Required] The child person identifier.

integer

Required

courseId

[Required] The course identifier.

integer

Required

fromDate

[Optional] The start date for filtering calendar events. Time zone is UTC. Date has to contain also time, for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS.

date

None.

toDate

[Optional] The stop date for filtering calendar events. Time zone is UTC. Date has to contain also time, for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS.

date

None.

PageIndex

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

A list of entities .

EntityListOfItslearning.RestApi.Entities.Personal.Calendar.CalendarEventV2
NameDescriptionTypeAdditional information
EntityArray

Collection of Itslearning.RestApi.Entities.Personal.Calendar.CalendarEventV2

None.

Total

integer

None.

CurrentPageIndex

integer

None.

PageSize

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityArray": [
    {
      "EventId": 1,
      "FromDate": "2025-06-20T06:16:51Z",
      "ToDate": "2025-06-20T06:16:51Z",
      "EventTitle": "sample string 4",
      "Description": "sample string 5",
      "ImportDescription": "sample string 6",
      "EventType": "Course",
      "LocationId": 7,
      "LocationGroupId": 8,
      "LocationColor": "sample string 9",
      "LocationFillColor": "sample string 10",
      "LocationTitle": "sample string 11",
      "LocationFriendlyName": "sample string 12",
      "HidePersonalWordForPersonalEvent": true,
      "AttendanceDetails": {
        "KeepAttendancePageUrl": "sample string 1",
        "AttendanceStatistics": {
          "Present": 1,
          "Absent": 2,
          "Excluded": 3
        }
      }
    },
    {
      "EventId": 1,
      "FromDate": "2025-06-20T06:16:51Z",
      "ToDate": "2025-06-20T06:16:51Z",
      "EventTitle": "sample string 4",
      "Description": "sample string 5",
      "ImportDescription": "sample string 6",
      "EventType": "Course",
      "LocationId": 7,
      "LocationGroupId": 8,
      "LocationColor": "sample string 9",
      "LocationFillColor": "sample string 10",
      "LocationTitle": "sample string 11",
      "LocationFriendlyName": "sample string 12",
      "HidePersonalWordForPersonalEvent": true,
      "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>
    <CalendarEventV2>
      <AttendanceDetails>
        <AttendanceStatistics>
          <Absent>2</Absent>
          <Excluded>3</Excluded>
          <Present>1</Present>
        </AttendanceStatistics>
        <KeepAttendancePageUrl>sample string 1</KeepAttendancePageUrl>
      </AttendanceDetails>
      <Description>sample string 5</Description>
      <EventId>1</EventId>
      <EventTitle>sample string 4</EventTitle>
      <EventType>Course</EventType>
      <FromDate>2025-06-20T06:16:51Z</FromDate>
      <HidePersonalWordForPersonalEvent>true</HidePersonalWordForPersonalEvent>
      <ImportDescription>sample string 6</ImportDescription>
      <LocationColor>sample string 9</LocationColor>
      <LocationFillColor>sample string 10</LocationFillColor>
      <LocationFriendlyName>sample string 12</LocationFriendlyName>
      <LocationGroupId>8</LocationGroupId>
      <LocationId>7</LocationId>
      <LocationTitle>sample string 11</LocationTitle>
      <ToDate>2025-06-20T06:16:51Z</ToDate>
    </CalendarEventV2>
    <CalendarEventV2>
      <AttendanceDetails>
        <AttendanceStatistics>
          <Absent>2</Absent>
          <Excluded>3</Excluded>
          <Present>1</Present>
        </AttendanceStatistics>
        <KeepAttendancePageUrl>sample string 1</KeepAttendancePageUrl>
      </AttendanceDetails>
      <Description>sample string 5</Description>
      <EventId>1</EventId>
      <EventTitle>sample string 4</EventTitle>
      <EventType>Course</EventType>
      <FromDate>2025-06-20T06:16:51Z</FromDate>
      <HidePersonalWordForPersonalEvent>true</HidePersonalWordForPersonalEvent>
      <ImportDescription>sample string 6</ImportDescription>
      <LocationColor>sample string 9</LocationColor>
      <LocationFillColor>sample string 10</LocationFillColor>
      <LocationFriendlyName>sample string 12</LocationFriendlyName>
      <LocationGroupId>8</LocationGroupId>
      <LocationId>7</LocationId>
      <LocationTitle>sample string 11</LocationTitle>
      <ToDate>2025-06-20T06:16:51Z</ToDate>
    </CalendarEventV2>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>