educationSchool resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A school. The educationSchool resource currently corresponds to an administrativeUnit resource and shares the same ID.

This resource is a subtype of educationOrganization.

Methods

Method Return Type Description
Get educationSchool Read properties and relationships of an educationSchool object.
Add class educationClass Add a new educationClass for the school by posting to the classes navigation property.
List classes educationClass collection Get the educationClass object collection.
Remove class educationClass Remove an educationClass from the school through the classes navigation property.
Add user educationUser Add a new educationUser for the school by posting to the users navigation property.
List users educationUser collection Get the educationUser object collection.
Remove user educationUser Remove an educationUser from the school through the users navigation property.
Get administrativeUnit administrativeUnit Get the administrativeUnit that corresponds to this educationSchool.
Update educationSchool Update an educationSchool object.
Delete None Delete an educationSchool object.
Delta educationSchool collection Get incremental changes for educationSchools

Properties

Property Type Description
id String GUID of this school.
address physicalAddress Address of the school.
createdBy identitySet Entity who created the school.
description String Description of the school.
displayName String Display name of the school.
externalId String ID of school in syncing system.
externalPrincipalId String ID of principal in syncing system.
externalSource String The type of external source this resource was generated from (automatically determined from externalSourceDetail). Possible values are: sis, lms, or manual.
externalSourceDetail String The name of the external source from which this resource was generated.
highestGrade String Highest grade taught.
lowestGrade String Lowest grade taught.
phone String Phone number of school.
principalEmail String Email address of the principal.
principalName String Name of the principal.
schoolNumber String School Number.

Relationships

Relationship Type Description
classes educationClass collection Classes taught at the school. Nullable.
users educationUser collection Users in the school. Nullable.

JSON representation

Here's a JSON representation of the resource.

{
  "address": { "@odata.type": "microsoft.graph.physicalAddress" },
  "createdBy": { "@odata.type": "microsoft.graph.identitySet" },
  "description": "String",
  "displayName": "String",
  "externalId": "String",
  "externalPrincipalId": "String",
  "externalSource": "string",
  "highestGrade": "String",
  "id": "String (identifier)",
  "lowestGrade": "String",
  "phone": "String",
  "principalEmail": "String",
  "principalName": "String",
  "schoolNumber": "String"
}