educationSchool: delta

Namespace: microsoft.graph

Get newly created or updated schools without having to perform a full read of the entire school collection. See Use delta query for details.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) EduRoster.ReadBasic EduRoster.Read, EduRoster.ReadWrite
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduRoster.ReadBasic.All EduRoster.Read.All, EduRoster.ReadWrite.All, EduRoster.WriteWrite.All

HTTP request

GET /education/schools/delta

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a educationSchool collection in the response body. The response also includes a @odata.nextLink URL or a @odata.deltaLink URL.

  • If a @odata.nextLink URL is returned, there are additional pages of data to be retrieved in the session. The application continues making requests using the @odata.nextLink URL until a @odata.deltaLink URL is included in the response.
  • If a @odata.deltaLink URL is returned, there is no more data about the existing state of the resource to be returned. Persist and use the @odata.deltaLink URL to learn about changes to the resource in the future.

For details, see Using delta query. For example requests, see Get incremental changes for users.

Examples

Request

GET https://graph.microsoft.com/v1.0/education/schools/delta

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(educationSchool)",
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/education/schools/delta?$skiptoken=VwhMSQw1l1O5v2F1ZPm...",
  "value": [
    {
      "@odata.type": "#microsoft.graph.educationSchool",
      "id": "String (identifier)",
      "displayName": "String",
      "description": "String",
      "externalSource": "String",
      "externalSourceDetail": "String",
      "principalEmail": "String",
      "principalName": "String",
      "externalPrincipalId": "String",
      "lowestGrade": "String",
      "highestGrade": "String",
      "schoolNumber": "String",
      "externalId": "String",
      "phone": "String",
      "fax": "String",
      "createdBy": {
        "@odata.type": "microsoft.graph.identitySet"
      },
      "address": {
        "@odata.type": "microsoft.graph.physicalAddress"
      }
    }
  ]
}