educationschool プロパティを更新するUpdate educationschool properties

学校オブジェクトのプロパティを更新します。Update the properties of a school object.


この 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) サポートされていません。Not supported.
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication EduRoster.ReadWrite.AllEduRoster.ReadWrite.All

HTTP 要求HTTP request

PATCH /education/schools/{id}

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。In the request body, supply the values for relevant fields that should be updated. 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。For best performance, don't include existing values that haven't changed.

プロパティProperty Type 説明Description
displayNamedisplayName StringString 学校の表示名Display name of the school
descriptiondescription StringString 学校の説明Description of the school
principalEmailprincipalEmail StringString プリンシパルの電子メール アドレスEmail address of the principal
principalNameprincipalName StringString プリンシパルの名前Name of the principal
externalPrincipalIdexternalPrincipalId StringString 同期システム内のプリンシパルの ID。Id of principal in syncing system.
highestGradehighestGrade StringString 授業を受けている最高学年。Highest grade taught.
lowestGradelowestGrade StringString 授業を受けている最低学年。Lowest grade taught.
schoolNumberschoolNumber StringString 学校番号。School Number.
externalIdexternalId StringString 同期システム内の学校の ID。Id of school in syncing system.
phonephone StringString 学校の電話番号。Phone number of school.
faxfax StringString 学校の FAX 番号。Fax number of school.
addressaddress physicalAddressphysicalAddress 学校のアドレス。Address of the School.
createdBycreatedBy identitySetidentitySet 学校を作成したエンティティ。Entity who created the school.


成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された educationSchool オブジェクトを返します。If successful, this method returns a 200 OK response code and an updated educationSchool object in the response body.



要求の例を次に示します。The following is an example of the request.

Content-type: application/json
Content-length: 292

  "displayName": "Fabrikam Arts High School",
  "description": "Magnate school for the arts. Los Angeles School District"

応答の例を次に示します。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: 292

  "id": "10002",
  "displayName": "Fabrikam Arts High School",
  "description": "Magnate school for the arts. Los Angeles School District",
  "status": "String",
  "externalSource": "String",
  "principalEmail": "",
  "principalName": "Amy Roebuck",
  "externalPrincipalId": "14007",
  "highestGrade": "12",
  "lowestGrade": "9",
  "schoolNumber": "10002",
  "address": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  "externalId": "10002",
  "fax": "+1 (253) 555-0101",
  "phone": "+1 (253) 555-0102"