Skip to navigation

GetStudent

View as Markdown

Get details of a single student

Input variables

  • studentId: id of the student

School periods and tags

schoolPeriods lists every school period the student is enrolled in. Each entry’s id is the student’s enrollment in that period (the periodStudentId on invoice fee lines, and id in GetPeriodStudents).

Tags are given to a student per school period, so they sit on each period rather than on the student: schoolPeriods[].schoolTags. Each tag carries id, name, color, entityType (STUDENT_TO_SEMESTER for student tags) and parentSchoolTagId (the tag group it belongs to, or null). See GetStudents for more.

Path parameters

studentIdstringRequired

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.

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
emailstringformat: "email"
firstnamestring
lastnamestring
middlenamestring
addressstring
genderstring
countrystring
citystring
telephonestring
birthdatedate
birthplacestring
customFieldsobject
schoolPeriodslist of objects
guardianslist of objects
mobileanyOptional