DreamClass APIAnnouncements

GetAnnouncements

View as Markdown

Get the list of announcements for a school period.

semesterId: Check the GetSchoolPeriods call

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

semesterIdstringOptional
School period id. Check the GetSchoolPeriods call

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
X-Content-Type-OptionsstringOptional
Cache-ControlstringOptional

Response

OK
idinteger
titlestring
contentstring
typestring
publicationDatedate
createdAtdatetime
semesterIdinteger
authorstring
hasAttachmentboolean
classIdslist of any
classCourseIdslist of any