title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
Create educationClass |
Create a new educationClass object. |
mlafleur |
medium |
education |
apiPageType |
Namespace: microsoft.graph
Create a new educationClass object.
Note
This will also create a universal group. When you use this API to create a class, it will add special properties to the group, which will add features such as assignments and special handling within Microsoft Teams when teams are created using the group. Please note that this API only creates the universal group and does not create a team. Microsoft Teams provides a user interface for teachers to create teams for their own classes using the groups created by this API.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
POST /education/classes
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
In the request body, supply a JSON representation of the educationClass object.
The following table lists the properties that are required when you create the educationClass.
Property | Type | Description |
---|---|---|
id | String | Object identifier. Inherited from entity |
displayName | String | Name of the class. |
mailNickname | String | Mail name for sending email to all members, if this is enabled. |
description | String | Description of the class. |
createdBy | identitySet | Entity who created the class |
classCode | String | Class code used by the school to identify the class. |
externalName | String | Name of the class in the syncing system. |
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 resources was generated from. |
grade | String | Grade level of the class. |
term | educationTerm | Term for this class. |
If successful, this method returns a 201 Created
response code and an educationClass object in the response body.
POST https://graph.microsoft.com/v1.0/education/classes
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.educationClass",
"displayName": "String",
"mailNickname": "String",
"description": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"classCode": "String",
"externalName": "String",
"externalId": "String",
"externalSource": "String",
"externalSourceDetail": "String",
"grade": "String",
"term": {
"@odata.type": "microsoft.graph.educationTerm"
}
}
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.educationClass",
"id": "64ef8ce5-8ce5-64ef-e58c-ef64e58cef64",
"displayName": "String",
"mailNickname": "String",
"description": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"classCode": "String",
"externalName": "String",
"externalId": "String",
"externalSource": "String",
"externalSourceDetail": "String",
"grade": "String",
"term": {
"@odata.type": "microsoft.graph.educationTerm"
}
}