educationSchool resource type

  • 2 minutes to read
  • Contributors

A resource representing a school and used to manage the classes, teachers, and students of the represented school.

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.
Update educationSchool Update an educationSchool object.
Delete None Delete an educationSchool object.

Properties

Property Type Description
id String GUID of this school.
displayName String Display name of the school.
description String Description of the school.
status string Read-Only. The possible values are: inactive, active, expired, deleteable.
externalSource educationExternalSource Read-Only. The possible values are: sis, manual, unknownFutureValue.
principalEmail String Email address of the principal.
principalName String Name of the principal.
externalPrincipalId String ID of principal in syncing system.
highestGrade String Highest grade taught.
lowestGrade String Lowest grade taught.
schoolNumber String School Number.
externalId String ID of school in syncing system.
phone String Phone number of school.
fax String Fax number of school.
address physicalAddress Address of the school.
createdBy identitySet Entity who created the school.

Relationships

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

JSON representation

The following is a JSON representation of the resource.

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