GetRecurringEvents

GET

/dreamclassapi/v1/calendar/event/recurring

GET

/dreamclassapi/v1/calendar/event/recurring

1 curl -G https://https//https/dreamclassapi/v1/calendar/event/recurring \
2      -H "tenant: {{tenant}}" \
3      -H "schoolCode: {{schoolCode}}" \
4      --data-urlencode periodId={{schoolperiodid}}

200Calendar_GetRecurringEvents_example

1 [
2   {
3     "id": 12,
4     "title": "Math",
5     "duration": 15,
6     "createdBy": "test@mail.io",
7     "visibleToStudents": true,
8     "visibleToProfessors": true,
9     "rrule": "DTSTART;TZID=US/Pacific:20241022T093000\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241223T215959;INTERVAL=1"
10   },
11   {
12     "id": 23,
13     "title": "Weekly Standup",
14     "duration": 10,
15     "createdBy": "test@mail.io",
16     "visibleToStudents": true,
17     "visibleToProfessors": true,
18     "rrule": "DTSTART;TZID=US/Pacific:20241022T103000\nRRULE:FREQ=WEEKLY;BYDAY=FR;UNTIL=20241223T215959;INTERVAL=1",
19     "description": null
20   }
21 ]

Get list of recurring events

Input variables

period: id of the School Period

Get list of recurring events Input variables - period: id of the School Period

Query parameters

periodIdstringOptional

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

titlestring

durationinteger

createdBystringformat: "email"

visibleToStudentsboolean

visibleToProfessorsboolean

rrulestring

descriptionanyOptional