GetPeriodStudents
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
idof each entry in this list,schoolPeriods[].idin GetStudent and GetStudents, andfees[].periodStudentIdon an invoice’s fee lines. Use it with the fee line’sschoolPeriodIdto 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
schoolPeriodId
Headers
dreamclass-secret-key
Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.
tenant
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.
schoolCode
Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.
Query parameters
studentId
Id of student (optional)
Response
OK
id
active
levels
student
addedAt
schoolTags
studentToClassesCourses
