学校をリストするList schools

ユーザーの学校のリストを取得します。Retrieve a list of schools for a user.

注: 委任されたトークンを使用した場合、メンバーは自分の学校に関する情報以外を参照できません。Note: If the delegated token is used, members can only see information about their own schools. この場合は ...beta/education/me/schools リソースを使用してください。Use the ...beta/education/me/schools resource in this case.

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

HTTP 要求HTTP request

GET /education/me/schools
GET /education/users/{id}/schools

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports the OData Query Parameters to help customize the response.

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文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 a collection of educationSchool objects in the response body.

Example

要求Request

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

GET https://graph.microsoft.com/v1.0/education/me/schools
応答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: 345

{
  "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",
      "fax": "+1 (253) 555-0101",
      "phone": "+1 (253) 555-0102",
    }
  ]
}

SDK サンプルコードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var schools = await graphClient.Education.Me.Schools
    .Request()
    .GetAsync();

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.