Listar membros de um educationClass
Namespace: microsoft.graph
Recupera os membros educationUser de um educationClass.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | EduRoster.ReadBasic | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | EduRoster.Read.All | EduRoster.ReadWrite.All, Member.Read.Hidden |
Observação
Se o token delegado for usado, os membros só poderão ver informações sobre suas próprias aulas.
Solicitação HTTP
GET /education/classes/{id}/members
Parâmetros de consulta opcionais
Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta, incluindo $search
, $count
, e $filter
.
Quando itens são adicionados ou atualizados para este recurso, eles são indexados especialmente para uso com os $count
e $search
parâmetros de consulta. Pode haver um pequeno atraso entre quando um item é adicionado ou atualizado e quando está disponível no índice.
Para obter mais informações sobre as opções de consulta OData, veja Parâmetros de consulta OData .
Cabeçalhos de solicitação
Cabeçalho | Valor |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se bem-sucedido, esse método retornará um código de resposta 200 OK
e uma coleção de objetos educationUser no corpo da resposta.
Exemplo
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/v1.0/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/members
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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@contoso.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@contoso.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@contoso.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@contoso.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@contoso.com",
"userType": "Member",
"primaryRole": "student",
"onPremisesInfo": {
"immutableId": null
},
"student": {}
}
]
}