educationSchools をリストする
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
すべての学校オブジェクトのリストを取得します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | 特権の高いアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | EduRoster.ReadBasic | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | EduRoster.Read.All | EduRoster.ReadWrite.All |
HTTP 要求
GET /education/schools
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。
要求ヘッダー
ヘッダー | 値 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で educationSchool オブジェクトのコレクションを返します。
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/education/schools
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"value":[
{
"id":"10001",
"displayName":"Contoso High School",
"description":"Public 9-12 high school",
"status":"active",
"externalSource":"sis",
"principalEmail":"amyr@contoso.com",
"principalName":"Amy Roebuck",
"externalPrincipalId":"14007",
"highestGrade":"12",
"lowestGrade":"9",
"schoolNumber":"10001",
"address":{
"city":"Los Angeles",
"countryOrRegion":"United States",
"postalCode":"98055",
"state":"CA",
"street":"12345 Main St."
},
"createdBy":{
"user":{
"displayName":"Susana Rocha",
"id":"14012"
}
},
"externalId":"10001",
"phone":"+1 (253) 555-0102"
}
]
}