educationClass resource type
Namespace: microsoft.graph
Represents a class within a school. The educationClass resource corresponds to the Microsoft 365 group and shares the same ID. Students are regular members of the class, and teachers are owners and have appropriate rights. For Office experiences to work correctly, teachers must be members of both the teachers and members collections.
Inherits from entity.
Methods
Method | Return type | Description |
---|---|---|
List classes | educationClass collection | Get a list of the educationClass objects and their properties. |
List modules | educationModulecollection | Get an educationModule object collection. |
Create class | educationClass | Create a new educationClass object. |
Get class | educationClass | Read the properties and relationships of an educationClass object. |
Update class | educationClass | Update the properties of an educationClass object. |
Delete class | None | Delete an educationClass object. |
Get delta | educationClass collection | Get incremental changes for educationClasses. |
Properties
Property | Type | Description |
---|---|---|
classCode | String | Class code used by the school to identify the class. |
createdBy | identitySet | Entity who created the class |
description | String | Description of the class. |
displayName | String | Name of the class. |
externalId | String | ID of the class from the syncing system. |
externalSource | educationExternalSource | How this class was created. Possible values are: sis , manual . |
externalSourceDetail | String | The name of the external source this resource was generated from. |
externalName | String | Name of the class in the syncing system. |
grade | String | Grade level of the class. |
id | String | Object identifier. Inherited from entity. |
mailNickname | String | Mail name for sending email to all members, if this is enabled. |
term | educationTerm | Term for this class. |
Relationships
Relationship | Type | Description |
---|---|---|
assignments | educationAssignment collection | All assignments associated with this class. Nullable. |
assignmentCategories | educationCategory collection | All categories associated with this class. Nullable. |
assignmentDefaults | educationAssignmentDefaults collection | Specifies class-level defaults respected by new assignments created in the class. |
assignmentSettings | educationAssignmentSettings collection | Specifies class-level assignments settings. |
group | group | The underlying Microsoft 365 group object. |
members | educationUser collection | All users in the class. Nullable. |
modules | educationModule collection | All modules in the class. Nullable. |
schools | educationSchool collection | All schools that this class is associated with. Nullable. |
teachers | educationUser collection | All teachers in the class. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.educationClass",
"description": "String",
"displayName": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"classCode": "String",
"externalName": "String",
"externalId": "String",
"externalSource": "String",
"externalSourceDetail": "String",
"grade": "String",
"id": "String (identifier)",
"mailNickname": "String",
"term": {
"@odata.type": "microsoft.graph.educationTerm"
}
}