Constructor
new ClassGroup(client, response)
Instantiate a ClassGroup object.
Name | Type | Description |
---|---|---|
client |
Client | The client that is instantiating the object. |
response |
Object | The data for the object. |
- Source:
Members
(private) _client :Client
The client that instantiated this object.
- Client
- Source:
academic_year_id :Number
The ID of the academic year that the class group is in.
- Number
- Source:
class_year :String
The class year that the class group is in.
- String
- Source:
id :Number
The ID of the class group
- Number
- Source:
imported_via_sims :Boolean
Whether or not the class group has been imported via sims.
- Boolean
- Source:
is_registration_group :Boolean
Whether or not the class group is a registration group.
- Boolean
- Source:
left_at :Number
The timestamp of when the class group left. (?)
- Number
- Source:
links :Object
Links for API resources for the class group.
- Object
- Source:
name :String
The name of the class group.
- String
- Source:
school_id :Number
The ID of the school that the class group belongs to.
- Number
- Source:
student_ids :Array.<Number>
An array of IDs for students in the class group.
- Array.<Number>
- Source:
teacher_ids :Array.<Number>
An array of IDs for teachers in the class group.
- Array.<Number>
- Source:
Methods
getSchool() → {Promise.<School>}
Get the school that the class group belongs to.
- Source:
- Type
- Promise.<School>
getStudents(idsopt) → {Promise.<Array.<Student>>}
Get students in the class group.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of student IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<Student>>
getTeachers(idsopt) → {Promise.<Array.<Employee>>}
Get teachers in the class group.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of teacher IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<Employee>>