educationClass resource type

  • 2 minutes to read
  • Contributors
    • mmast-msft
    • Jeremy Thake (Microsoft)
    • Office GSX
    • daron
    • Laura Graham

Represents a class within a school. The educationClass resource corresponds to the Office 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.

Methods

Method Return Type Description
Get educationClass educationClass Read properties and relationships of an educationClass object.
Add member educationUser Add a new educationUser for the class by posting to the members navigation property.
List members educationUser collection Get an educationUser object collection.
Remove student educationUser Remove an educationUser from the class through the members navigation property.
List schools educationSchool collection Get an educationSchool object collection.
Add teacher educationUser Add a new educationUser for the class by posting to the teachers navigation property.
List teachers educationUser collection Get a list of teachers for the class.
Remove teacher educationUser Remove an educationUser from the class through the teachers navigation property.
Get group group Get the Office 365 group that corresponds to this educationClass.
Update educationClass Update educationClass object.
Delete None Delete educationClass object.

Properties

Property Type Description
id String Unique identifier for the class.
description String Description of the class.
displayName String Name of the class.
mailNickname String Mail name for sending email to all members, if this is enabled.
createdBy identitySet Entity who created the class
classCode String Class code used by the school to identify the class.
externalId String ID of the class from the syncing system.
externalName String Name of the class in the syncing system.
externalSource educationExternalSource How this class was created. The possible values are: sis, manual, unknownFutureValue.
term educationTerm Term for this class.

Relationships

Relationship Type Description
members educationUser collection All users 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.
group group The directory group corresponding to this class.

JSON representation

The following is a JSON representation of the resource.

{
  "id": "String",
  "description": "String",
  "classCode": "String",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "displayName": "String",
  "externalId": "String",
  "externalName": "String",
  "externalSource": "string",
  "mailNickname": "String",
  "term": {"@odata.type": "microsoft.graph.educationTerm"}
}