Skip to navigation

GetPeriodStudents

View as Markdown

Get details of all students of a single period.

See also GetPeriodClassCourses

Input variables

  • schoolPeriodId: id of the School Period
  • studentId (optional): return only this student’s enrollment in the period
  • periodStudentId (optional): return only this enrollment. It is the id of each entry in this list, schoolPeriods[].id in GetStudent and GetStudents, and fees[].periodStudentId on an invoice’s fee lines. Use it with the fee line’s schoolPeriodId to look up one student without fetching the whole period.

With both filters, the enrollment is returned only if it belongs to that student; otherwise the list is empty. A periodStudentId from another period also returns an empty list.

Path parameters

schoolPeriodIdstringRequired

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

studentIdstringOptional

Id of student (optional)

Response

OK
idinteger
activeboolean
levelslist of objects
studentobject
addedAtdatetime
schoolTagslist of objects
studentToClassesCourseslist of objects