educationSchool: deltaeducationSchool: delta

命名空间:microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph 中的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported.

获取新创建或更新的学校,而无需对整个学校集合执行完全读取。Get newly created or updated schools without having to perform a full read of the entire school collection. 有关详细信息,请参阅使用 delta 查询See Use delta query for details.

权限Permissions

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限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.read.all、User.readbasic.all、Eduroster.read.all 或 Eduroster.read.allEduRoster.ReadBasic, EduRoster.Read, or EduRoster.ReadWrite
委派(个人 Microsoft 帐户)Delegated (personal Microsoft account) 不支持。Not supported.
应用程序Application Eduroster.read.all、Eduroster.read.all、All 或 Eduroster.read.all 的所有 User.readbasic.allEduRoster.ReadBasic.All, EduRoster.Read.All, or EduRoster.WriteWrite.All

HTTP 请求HTTP request

GET /education/schools/delta

请求标头Request headers

名称Name 说明Description
AuthorizationAuthorization Bearer {code}Bearer {code}

请求正文Request body

请勿提供此方法的请求正文。Do not supply a request body for this method.

响应Response

如果成功,此方法 200 OK 在响应正文中返回响应代码和educationSchool集合对象。If successful, this method returns a 200 OK response code and an educationSchool collection object in the response body.

重要

educationSchool 增量不包括已删除的学校。educationSchool deltas do not include deleted schools.

示例Example

以下示例演示如何调用此 API。The following example shows how to call this API.

请求Request

下面展示了示例请求。The following is an example of the request.

GET https://graph.microsoft.com/beta/education/schools/delta

响应Response

下面展示了示例响应。The following is an example of the response.

注意: 为了提高可读性,可能缩短了此处显示的响应对象。所有属性都将通过实际调用返回。Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 313

{
  "value": [
    {
      "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"
    }
  ]
}