List schools

Namespace: microsoft.graph

Retrieve a list of schools in which the class is taught.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	EduRoster.ReadBasic
Delegated (personal Microsoft account)	Not supported.
Application	EduRoster.Read.All, EduRoster.ReadWrite.All

HTTP request

GET /education/classes/{id}/schools

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Header	Value
Authorization	Bearer {token}. Required.

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 educationSchool objects in the response body.

Example

Request

The following is an example of the request.

HTTP

GET https://graph.microsoft.com/v1.0/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/schools

C#

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Education.Classes["{educationClass-id}"].Schools.GetAsync();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let schools = await client.api('/education/classes/7e4ec76c-8276-43ef-ba10-9aaa197cb212/schools')
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EducationSchoolCollectionWithReferencesPage schools = graphClient.education().classes("7e4ec76c-8276-43ef-ba10-9aaa197cb212").schools()
	.buildRequest()
	.get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


result, err := graphClient.Education().ClassesById("educationClass-id").Schools().Get(context.Background(), nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Education

Get-MgEducationClassSchool -EducationClassId $educationClassId

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);


$requestResult = $graphServiceClient->education()->classesById('educationClass-id')->schools()->get();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.educationSchool)",
    "value": [
        {
            "id": "8a07f5a8-edc9-4847-bbf2-dde106594bf4",
            "displayName": "Management Fast Track",
            "description": null,
            "principalEmail": "aroebuck@principal.edu",
            "principalName": "Amy Roebuck",
            "externalPrincipalId": "14008",
            "externalId": "10002",
            "externalSource": "sis",
            "externalSourceDetail": "SIS",
            "phone": "555-123-4567",
            "address": {
                "city": "Redmond",
                "countryOrRegion": "US",
                "postalCode": "98052",
                "state": "WA",
                "street": "2 Microsoft Way"
            }
        }
    ]
}