GetSingleLectures

View as Markdown
Get list of single lectures Input variables - periodId: id of the School Period - dateFrom: minimum event date (optional, UTC) example: 2023-12-31T09:00:00 - dateTo: maximum event date (optional, UTC) example: 2023-12-31T09:00:00

Headers

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional
Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is "myaccount"), or your full white-labelled domain. Required on every request.
schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

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

OK
idinteger
titlestring
classCourseobject
scheduledAtdate
startDateTimedatetime
statusinteger
durationinteger
classroomobject
privateNotesanyOptional
publicNotesanyOptional
meetingPasswordanyOptional