Listar escolasList schools

Namespace: microsoft.graphNamespace: microsoft.graph

Recupere uma lista de escolas de um usuário.Retrieve a list of schools for a user.

Observação: se o token delegado for usado, os membros só poderão ver informações sobre as próprias escolas.Note: If the delegated token is used, members can only see information about their own schools. Nesse caso, use o recurso ...beta/education/me/schools.Use the ...beta/education/me/schools resource in this case.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegado (conta corporativa ou de estudante)Delegated (work or school account) EduRoster.ReadBasicEduRoster.ReadBasic
Delegado (conta pessoal da Microsoft)Delegated (personal Microsoft account) Sem suporte.Not supported.
AplicativoApplication EduRoster.Read.All, EduRoster.ReadWrite.AllEduRoster.Read.All, EduRoster.ReadWrite.All

Solicitação HTTPHTTP request

GET /education/me/schools
GET /education/users/{id}/schools

Parâmetros de consulta opcionaisOptional query parameters

Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta.This method supports the OData Query Parameters to help customize the response.

Cabeçalhos de solicitaçãoRequest headers

CabeçalhoHeader ValorValue
AutorizaçãoAuthorization {token} de portador. Obrigatório.Bearer {token}. Required.

Corpo da solicitaçãoRequest body

Não forneça um corpo de solicitação para esse método.Do not supply a request body for this method.

RespostaResponse

Se bem-sucedido, esse método retornará um código de resposta 200 OK e uma coleção de objetos educationSchool no corpo da resposta.If successful, this method returns a 200 OK response code and a collection of educationSchool objects in the response body.

ExemploExample

SolicitaçãoRequest

Este é um exemplo de solicitação.The following is an example of the request.

GET https://graph.microsoft.com/v1.0/education/me/schools
RespostaResponse

Este é um exemplo de resposta.The following is an example of the response.

Observação: o objeto response mostrado aqui pode ser encurtado para legibilidade. Todas as propriedades serão retornadas de uma chamada real.Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 345

{
  "value": [
    {
      "id": "10001",
      "displayName": "Contoso High School",
      "description": "Public 9-12 high school",
      "status": "active",
      "externalSource": "sis",
      "principalEmail": "amyr@contoso.com",
      "principalName": "Amy Roebuck",
      "externalPrincipalId": "14007",
      "highestGrade": "12",
      "lowestGrade": "9",
      "schoolNumber": "10001",
      "address": {
        "city": "Los Angeles",
        "countryOrRegion": "United States",
        "postalCode": "98055",
        "state": "CA",
        "street": "12345 Main St."
      },
      "createdBy": {
        "user": {
          "displayName": "Susana Rocha",
          "id": "14012",
        }
      },
      "externalId": "10001",
      "phone": "+1 (253) 555-0102",
    }
  ]
}