educationSchool リソースの種類educationSchool resource type

学校を表すリソースで、その学校のクラス、教師、学生を管理するために使用します。A resource representing a school and used to manage the classes, teachers, and students of the represented school.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
GetGet educationSchooleducationSchool educationSchool オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of an educationSchool object.
Add classAdd class educationClasseducationClass classes ナビゲーション プロパティに投稿することで、学校の新しい educationClass を追加します。Add a new educationClass for the school by posting to the classes navigation property.
List classesList classes educationClass コレクションeducationClass collection educationClass オブジェクト コレクションを取得します。Get the educationClass object collection.
Remove classRemove class educationClasseducationClass classes ナビゲーション プロパティによって、学校から educationClass を削除します。Remove an educationClass from the school through the classes navigation property.
Add userAdd user educationUsereducationUser users ナビゲーション プロパティを投稿することで、学校の新しい educationUser を追加します。Add a new educationUser for the school by posting to the users navigation property.
List usersList users educationUser コレクションeducationUser collection educationUser オブジェクト コレクションを取得します。Get the educationUser object collection.
Remove userRemove user educationUsereducationUser users ナビゲーション プロパティによって、学校から educationUser を削除します。Remove an educationUser from the school through the users navigation property.
UpdateUpdate educationSchooleducationSchool educationSchool オブジェクトを更新します。Update an educationSchool object.
DeleteDelete なしNone educationSchool オブジェクトを削除します。Delete an educationSchool object.

プロパティProperties

プロパティProperty Type 説明Description
idid 文字列String この学校の GUID。GUID of this school.
displayNamedisplayName 文字列String 学校の表示名。Display name of the school.
説明description StringString 学校の説明。Description of the school.
statusstatus stringstring 読み取り専用。Read-Only. 使用可能な値: inactiveactiveexpireddeleteableThe possible values are: inactive, active, expired, deleteable.
externalSourceexternalSource educationExternalSourceeducationExternalSource 読み取り専用です。Read-Only. 使用可能な値: sismanualunknownFutureValueThe possible values are: sis, manual, unknownFutureValue.
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.
addressaddress physicalAddressphysicalAddress 学校の住所。Address of the school.
createdBycreatedBy identitySetidentitySet 学校を作成したエンティティ。Entity who created the school.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
classesclasses educationClass コレクションeducationClass collection 学校で授業しているクラス。Classes taught at the school. Null 許容型。Nullable.
usersusers educationUser コレクションeducationUser collection 学校のユーザー。Users in the school. Null 許容型。Nullable.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。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",
  "phone": "String",
}