GET restapi/personal/children/{childId}/events/{eventId}/v1

Gets a single course calendar event for the child by the specified .

Request Information

URI Parameters

NameDescriptionTypeAdditional information
childId

[Required] The child person identifier.

integer

Required

eventId

[Required] The course event identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Calendar event .

Itslearning.RestApi.Entities.Personal.Calendar.CalendarEventDetails
NameDescriptionTypeAdditional information
EventUrl

The URL in itslearning web to open the calendar event in the web view. In case of course event there's the URL pointing to the course dashboard with opened calendar event pop-up dialog. In case of project or personal events there's the URL pointing to the calendar day view.

string

None.

HasMoreContent

Indicates whether calendar event contains more information than API can consume. For now it indicates whether Description or ImportDescription contain HTML text which is striped by API.

boolean

None.

Bookings

Rooms or equipment booked for the event.

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

None.

ElementLinks

Elements connected to the event.

Collection of Itslearning.RestApi.Entities.ElementLink

None.

PlanLinks

Plans relevant for the event.

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

None.

EventId

integer

None.

FromDate

date

None.

ToDate

date

None.

EventTitle

string

None.

Description

string

None.

ImportDescription

string

None.

EventType

Itslearning.RestApi.Entities.Personal.Calendar.CalendarEventType

None.

LocationId

integer

None.

LocationGroupId

integer

None.

LocationColor

string

None.

LocationFillColor

string

None.

LocationTitle

string

None.

LocationFriendlyName

string

None.

HidePersonalWordForPersonalEvent

If true and `EventType` is `Personal` then the word "Personal" must be hidden from UI for this event. This property is always false for non personal event types.

boolean

None.

AttendanceDetails

Itslearning.RestApi.Entities.Personal.Calendar.Attendance.AttendanceDetails

None.

Response Formats

application/json, text/json

Sample:
{
  "EventUrl": "sample string 1",
  "HasMoreContent": true,
  "Bookings": [
    {
      "Name": "sample string 1"
    },
    {
      "Name": "sample string 1"
    }
  ],
  "ElementLinks": [
    {
      "ElementId": 1,
      "ElementType": "Unknown",
      "Title": "sample string 2",
      "Url": "sample string 3",
      "ContentUrl": "sample string 4",
      "IconUrl": "sample string 5",
      "LearningToolId": 6,
      "Homework": true
    },
    {
      "ElementId": 1,
      "ElementType": "Unknown",
      "Title": "sample string 2",
      "Url": "sample string 3",
      "ContentUrl": "sample string 4",
      "IconUrl": "sample string 5",
      "LearningToolId": 6,
      "Homework": true
    }
  ],
  "PlanLinks": [
    {
      "PlanId": 1,
      "PlanName": "sample string 2",
      "TopicName": "sample string 3",
      "Url": "sample string 4"
    },
    {
      "PlanId": 1,
      "PlanName": "sample string 2",
      "TopicName": "sample string 3",
      "Url": "sample string 4"
    }
  ],
  "EventId": 3,
  "FromDate": "2025-06-17T05:21:29Z",
  "ToDate": "2025-06-17T05:21:29Z",
  "EventTitle": "sample string 6",
  "Description": "sample string 7",
  "ImportDescription": "sample string 8",
  "EventType": "Course",
  "LocationId": 9,
  "LocationGroupId": 10,
  "LocationColor": "sample string 11",
  "LocationFillColor": "sample string 12",
  "LocationTitle": "sample string 13",
  "LocationFriendlyName": "sample string 14",
  "HidePersonalWordForPersonalEvent": true,
  "AttendanceDetails": {
    "KeepAttendancePageUrl": "sample string 1",
    "AttendanceStatistics": {
      "Present": 1,
      "Absent": 2,
      "Excluded": 3
    }
  }
}

application/xml, text/xml

Sample:
<CalendarEventDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AttendanceDetails>
    <AttendanceStatistics>
      <Absent>2</Absent>
      <Excluded>3</Excluded>
      <Present>1</Present>
    </AttendanceStatistics>
    <KeepAttendancePageUrl>sample string 1</KeepAttendancePageUrl>
  </AttendanceDetails>
  <Description>sample string 7</Description>
  <EventId>3</EventId>
  <EventTitle>sample string 6</EventTitle>
  <EventType>Course</EventType>
  <FromDate>2025-06-17T05:21:29Z</FromDate>
  <HidePersonalWordForPersonalEvent>true</HidePersonalWordForPersonalEvent>
  <ImportDescription>sample string 8</ImportDescription>
  <LocationColor>sample string 11</LocationColor>
  <LocationFillColor>sample string 12</LocationFillColor>
  <LocationFriendlyName>sample string 14</LocationFriendlyName>
  <LocationGroupId>10</LocationGroupId>
  <LocationId>9</LocationId>
  <LocationTitle>sample string 13</LocationTitle>
  <ToDate>2025-06-17T05:21:29Z</ToDate>
  <Bookings>
    <Booking>
      <Name>sample string 1</Name>
    </Booking>
    <Booking>
      <Name>sample string 1</Name>
    </Booking>
  </Bookings>
  <ElementLinks>
    <ElementLink>
      <ContentUrl>sample string 4</ContentUrl>
      <ElementId>1</ElementId>
      <ElementType>Unknown</ElementType>
      <Homework>true</Homework>
      <IconUrl>sample string 5</IconUrl>
      <LearningToolId>6</LearningToolId>
      <Title>sample string 2</Title>
      <Url>sample string 3</Url>
    </ElementLink>
    <ElementLink>
      <ContentUrl>sample string 4</ContentUrl>
      <ElementId>1</ElementId>
      <ElementType>Unknown</ElementType>
      <Homework>true</Homework>
      <IconUrl>sample string 5</IconUrl>
      <LearningToolId>6</LearningToolId>
      <Title>sample string 2</Title>
      <Url>sample string 3</Url>
    </ElementLink>
  </ElementLinks>
  <EventUrl>sample string 1</EventUrl>
  <HasMoreContent>true</HasMoreContent>
  <PlanLinks>
    <PlanLink>
      <PlanId>1</PlanId>
      <PlanName>sample string 2</PlanName>
      <TopicName>sample string 3</TopicName>
      <Url>sample string 4</Url>
    </PlanLink>
    <PlanLink>
      <PlanId>1</PlanId>
      <PlanName>sample string 2</PlanName>
      <TopicName>sample string 3</TopicName>
      <Url>sample string 4</Url>
    </PlanLink>
  </PlanLinks>
</CalendarEventDetails>