Skip to content

Commit

Permalink
Update educationclass-list-members.md
Browse files Browse the repository at this point in the history
Applied standards to API topic.
  • Loading branch information
JarbasHorst authored Sep 10, 2023
1 parent 6af4bf0 commit 84c96ac
Showing 1 changed file with 79 additions and 77 deletions.
156 changes: 79 additions & 77 deletions api-reference/v1.0/api/educationclass-list-members.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "List members of an educationClass"
description: "Retrieves the teachers and students for a class. Note that if the delegated token is used, members can only be seen by other members of the class."
description: "Retrieves the teachers and students for a class."
ms.localizationpriority: medium
author: "mmast-msft"
ms.prod: "education"
Expand All @@ -19,7 +19,7 @@ One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) |
| :------------------------------------- | :------------------------------------------------------------------ |
| Delegated (work or school account) | EduRoster.ReadBasic |
| Delegated (personal Microsoft account) | Not supported |
| Delegated (personal Microsoft account) | Not supported. |
| Application | EduRoster.Read.All, EduRoster.ReadWrite.All plus Member.Read.Hidden |

> [!NOTE]
Expand All @@ -46,10 +46,12 @@ For more information on OData query options, see [OData query parameters](/graph

## Request body
Do not supply a request body for this method.

## Response
If successful, this method returns a `200 OK` response code and a collection of [educationUser](../resources/educationuser.md) objects in the response body.

## Example
##### Request
### Request
The following is an example of the request.

# [HTTP](#tab/http)
Expand Down Expand Up @@ -95,7 +97,7 @@ GET https://graph.microsoft.com/v1.0/education/classes/7e4ec76c-8276-43ef-ba10-9

---

##### Response
### Response
The following is an example of the response.

>**Note:** The response object shown here might be shortened for readability.
Expand All @@ -111,79 +113,79 @@ HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.educationUser)",
"value": [
{
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
"accountEnabled": true,
"displayName": "Adele Vance",
"givenName": "Adele",
"surname": "Vance",
"userPrincipalName": "AdeleV@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "teacher",
"onPremisesInfo": {
"immutableId": null
},
"teacher": {}
},
{
"id": "b66ecf79-a093-4d51-86e0-efcc4531f37a",
"accountEnabled": true,
"displayName": "Christie Cline",
"givenName": "Christie",
"surname": "Cline",
"userPrincipalName": "ChristieC@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
},
{
"id": "f5289423-7233-4d60-831a-fe107a8551cc",
"accountEnabled": true,
"displayName": "Ben Walters",
"givenName": "Ben",
"surname": "Walters",
"userPrincipalName": "BenW@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
},
{
"id": "48d31887-5fad-4d73-a9f5-3c356e68a038",
"accountEnabled": true,
"displayName": "Megan Bowen",
"givenName": "Megan",
"surname": "Bowen",
"userPrincipalName": "MeganB@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "teacher",
"onPremisesInfo": {
"immutableId": null
},
"teacher": {}
},
{
"id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755",
"accountEnabled": true,
"displayName": "Allan Deyoung",
"givenName": "Allan",
"surname": "Deyoung",
"userPrincipalName": "AllanD@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
}
]
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.educationUser)",
"value": [
{
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
"accountEnabled": true,
"displayName": "Adele Vance",
"givenName": "Adele",
"surname": "Vance",
"userPrincipalName": "AdeleV@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "teacher",
"onPremisesInfo": {
"immutableId": null
},
"teacher": {}
},
{
"id": "b66ecf79-a093-4d51-86e0-efcc4531f37a",
"accountEnabled": true,
"displayName": "Christie Cline",
"givenName": "Christie",
"surname": "Cline",
"userPrincipalName": "ChristieC@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
},
{
"id": "f5289423-7233-4d60-831a-fe107a8551cc",
"accountEnabled": true,
"displayName": "Ben Walters",
"givenName": "Ben",
"surname": "Walters",
"userPrincipalName": "BenW@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
},
{
"id": "48d31887-5fad-4d73-a9f5-3c356e68a038",
"accountEnabled": true,
"displayName": "Megan Bowen",
"givenName": "Megan",
"surname": "Bowen",
"userPrincipalName": "MeganB@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "teacher",
"onPremisesInfo": {
"immutableId": null
},
"teacher": {}
},
{
"id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755",
"accountEnabled": true,
"displayName": "Allan Deyoung",
"givenName": "Allan",
"surname": "Deyoung",
"userPrincipalName": "AllanD@M365x214355.onmicrosoft.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
}
]
}
```

Expand Down

0 comments on commit 84c96ac

Please sign in to comment.