educationSchool resource type
Namespace: microsoft.graph
A resource representing a school and used to manage the classes, teachers, and students of the represented school.
Inherits from educationOrganization.
Methods
Method | Return type | Description |
---|---|---|
List schools | educationSchool collection | Get a list of the educationSchool objects and their properties. |
Create school | educationSchool | Create a new educationSchool object. |
Get school | educationSchool | Read the properties and relationships of an educationSchool object. |
Update school | educationSchool | Update the properties of an educationSchool object. |
Delete school | None | Delete an educationSchool object. |
Get changes to schools | educationSchool collection | Get incremental changes to the resource collection. |
Properties
Property | Type | Description |
---|---|---|
address | physicalAddress | Address of the school. |
createdBy | identitySet | Entity who created the school. |
description | String | Description of the school. Inherited from educationOrganization. |
displayName | String | Display name of the school. Inherited from educationOrganization. |
externalId | String | ID of school in syncing system. |
externalPrincipalId | String | ID of principal in syncing system. |
externalSource | educationExternalSource | Source where this organization was created from. Inherited from educationOrganization. Possible values are: sis , manual . |
externalSourceDetail | String | The name of the external source this resource was generated from. |
highestGrade | String | Highest grade taught. |
id | String | Object identifier. Inherited from entity. |
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 |
---|---|---|
administrativeUnit | administrativeUnit | The underlying administrativeUnit for this school. |
classes | educationClass collection | Classes taught at the school. Nullable. |
users | educationUser collection | Users in the school. Nullable. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.educationSchool",
"address": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"description": "String",
"displayName": "String",
"externalId": "String",
"externalPrincipalId": "String",
"externalSource": "String",
"externalSourceDetail": "String",
"highestGrade": "String",
"id": "String (identifier)",
"lowestGrade": "String",
"phone": "String",
"principalEmail": "String",
"principalName": "String",
"schoolNumber": "String"
}