- Source:
Members
currentGPA :number
The student's current GPA, if grades are available (null if not).
Type:
- number
- Source:
currentMealBalance :number
The student's current meal balance, if supported.
Type:
- number
- Source:
currentTerm :number
The student's current term, if available (null if not).
Type:
- number
- Source:
dateOfBirth :Date
The student's date of birth.
Type:
- Date
- Source:
ethnicity :string
The student's ethnicity (can be one of many things determined by the school itself).
Type:
- string
- Source:
firstName :string
The student's first/given name.
Type:
- string
- Source:
gender :string
The student's gender (can be one of many things determined by the school itself).
Type:
- string
- Source:
gradeLevel :number
The grade the student is currently in.
Type:
- number
- Source:
id :number
The student's ID.
Type:
- number
- Source:
lastName :string
The student's last name/surname.
Type:
- string
- Source:
middleName :string
The student's middle name.
Type:
- string
- Source:
photoDate :Date
The date the student's photo was taken on.
Type:
- Date
- Source:
startingMealBalance :number
The student's starting meal balance, if supported.
Type:
- number
- Source:
Methods
getCurrentReportingTerm() → {PowerSchoolReportingTerm}
Get the current reporting term the student is in.
- Source:
Returns:
getFormattedName(includeMiddleNameopt) → {string}
Get student's name formatted for display.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
includeMiddleName |
boolean |
<optional> |
false | Whether or not to include the student's middle name. |
- Source:
Returns:
- Type
- string
getNameParts(includeMiddleNameopt) → {Array.<string>}
Get the parts making up a student's name.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
includeMiddleName |
boolean |
<optional> |
false | Whether or not to include the student's middle name. |
- Source:
Returns:
- Type
- Array.<string>