List taughtClasses
Namespace: microsoft.graph
Get the educationClass resources owned by an educationUser.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
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.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | EduRoster.ReadBasic | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | EduRoster.Read.All | EduRoster.ReadWrite.All |
Note
Note that if the delegated token is used, users can only see information about their own classes.
HTTP request
GET /education/me/taughtClasses
GET /education/users/{educationUserId}/taughtClasses
Optional query parameters
You can use the OData query option $orderby
to sort groups in an organization by the displayName values, as shown in the following example:
GET https://graph.microsoft.com/v1.0/groups?$orderby=displayName
You can also use the $filter
, $count
and $search
query parameters to limit the response.
When items are added or updated for this resource, they are specially indexed for use with the $count
and $search
query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
For more information on OData query options, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of educationClass objects in the response body.
Examples
Request
GET https://graph.microsoft.com/v1.0/education/users/{educationUserId}/taughtClasses
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"@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"
}
}
]
}