Constructor
new ClassYear(client, response)
Instantiate a ClassYear object.
Parameters:
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.
Type:
- Client
- Source:
active :Boolean
Whether or not the class year is active.
Type:
- Boolean
- Source:
class_group_ids :Array.<Number>
An array of class groups IDs in the class year.
Type:
- Array.<Number>
- Source:
created_at :Number
The timestamp of when the class year was created.
Type:
- Number
- Source:
has_students :Boolean
Whether or not the class year has students.
Type:
- Boolean
- Source:
id :Number
The ID of the class year.
Type:
- Number
- Source:
id :Number
The ID of the class year.
Type:
- Number
- Source:
name :String
The name of the class year.
Type:
- String
- Source:
position :Number
The position of the class year in the school.
Type:
- Number
- Source:
school_id :Number
The ID of the school that the class year belongs to.
Type:
- Number
- Source:
updated_at :Number
The timestamp of when the class year was last updated.
Type:
- Number
- Source:
Methods
getSchool() → {Promise.<School>}
Get the school that the class year belongs to.
- Source:
Returns:
- Type
- Promise.<School>