List classes of an educationSchool

Namespace: microsoft.graph

Get the educationClass resources owned by an educationSchool.

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/schools/{educationSchoolId}/classes

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

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

Example

Request

The following is an example of the request.

HTTP

GET https://graph.microsoft.com/v1.0/education/schools/f2598f43-629c-4ea9-9265-97a34839644e/classes

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

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

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

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



result, err := graphClient.Education().Schools().BySchoolId("educationSchool-id").Classes().Get(context.Background(), nil)

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();

EducationClassCollectionWithReferencesPage classes = graphClient.education().schools("f2598f43-629c-4ea9-9265-97a34839644e").classes()
	.buildRequest()
	.get();

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 classes = await client.api('/education/schools/f2598f43-629c-4ea9-9265-97a34839644e/classes')
	.get();

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);


$result = $graphServiceClient->education()->schools()->bySchoolId('educationSchool-id')->classes()->get();

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-MgEducationSchoolClass -EducationSchoolId $educationSchoolId

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.educationClass)",
    "value": [
        {
            "id": "733b514d-790b-4542-9efd-1558644d8b1e",
            "description": "Negotiation For Beginners training",
            "displayName": "Negotiation For Beginners",
            "mailNickname": "NegotiationForBeginners"
        },
        {
            "id": "be29b3cb-f58e-4c83-9f58-ed082c317c2d",
            "description": "Advanced Presentation Skills training",
            "displayName": "Advanced Presentation Skills",
            "mailNickname": "AdvancedPresentationSkills"
        },
        {
            "id": "ef18b112-d6dc-4b56-8cee-85f82dbe8a7d",
            "description": "Presentation Skills 101 training",
            "displayName": "Presentation Skills 101",
            "mailNickname": "PresentationSkills101"
        }
    ]
}