AddRecurringLecture | DreamClass

curl -X POST https://api.dreamclass.io/dreamclassapi/v1/calendar/lecture/recurring \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "startDateTime": "2024-11-05T10:10:00",
  "title": "Introduction to Programming",
  "classCourse": {
    "id": 46
  },
  "duration": 60,
  "classroom": {
    "id": 8
  },
  "meetingLink": "https://example.com/meeting",
  "meetingPassword": "password123",
  "rrule": "DTSTART;TZID=USA/Pacific:20241101T130000\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1"
}'

{
  "id": 12,
  "startDateTime": "2024-11-05T10:10:00",
  "title": "Introduction to Programming",
  "classCourse": {
    "id": 46
  },
  "duration": 60,
  "classroom": {
    "id": 8
  },
  "meetingLink": "https://example.com/meeting",
  "meetingPassword": "password123",
  "rrule": "DTSTART;TZID=USA/Pacific:20241101T130000\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241231T215959;INTERVAL=1"
}

Add recurring lecture

This API endpoint allows you to add a recurring lecture by specifying a recurrence rule. The recurrence rule must follow the iCalendar specification, using the DTSTART and RRULE elements to define the lecture’s start date and recurrence pattern.

Parameters

rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule consists of:
- A DTSTART element on the first line, specifying the start date and time of the lecture.
- An RRULE element on the second line, specifying the recurrence pattern (e.g. daily, weekly, monthly).

Each element must be on its own line, separated by a newline character (\n). Give both times in UTC (a trailing Z), for example:

DTSTART:20260907T090000Z
RRULE:FREQ=WEEKLY;BYDAY=MO,WE;UNTIL=20261218T235959Z

Lecture status

1: SCHEDULED

2: COMPLETED

3: CANCELLED

4: DELETED

Add recurring lecture This API endpoint allows you to add a recurring lecture by specifying a recurrence rule. The recurrence rule must follow the [iCalendar specification](https://icalendar.org), using the `DTSTART` and `RRULE` elements to define the lecture's start date and recurrence pattern. #### Parameters - rrule: A string defining the start date and recurrence rule, following the iCalendar format. The rule consists of: - A `DTSTART` element on the first line, specifying the start date and time of the lecture. - An `RRULE` element on the second line, specifying the recurrence pattern (e.g. daily, weekly, monthly). Each element must be on its own line, separated by a newline character (`\n`). Give both times in UTC (a trailing `Z`), for example: ``` DTSTART:20260907T090000Z RRULE:FREQ=WEEKLY;BYDAY=MO,WE;UNTIL=20261218T235959Z ``` **Lecture status** 1: SCHEDULED 2: COMPLETED 3: CANCELLED 4: DELETED

Headers

Request

This endpoint expects an object.

startDateTimedatetimeRequired

titlestringRequired

classCourseobjectRequired

durationintegerRequired

classroomobjectRequired

meetingLinkstringRequiredformat: "uri"

meetingPasswordstringRequired

rrulestringRequired

Response headers

ExpiresstringOptional

Cache-ControlstringOptional

Access-Control-Allow-HeadersstringOptional

X-XSS-ProtectionstringOptional

PragmastringOptional

Access-Control-Allow-MethodsstringOptional

X-Frame-OptionsstringOptional

Access-Control-Expose-HeadersstringOptional

Access-Control-Allow-OriginstringOptional

Access-Control-Allow-CredentialsstringOptional

X-Content-Type-OptionsstringOptional

Access-Control-Max-AgestringOptional

Response

idinteger

startDateTimedatetime

titlestring

classCourseobject

durationinteger

classroomobject

meetingLinkstringformat: "uri"

meetingPasswordstring

rrulestring