Table of contents
TOC
目次を折りたたむ
目次を展開する
最終更新日: 2017/11/10

認証に関するガイドライン

OAuth2 実装のために、各 LMS が認証コードの許可の流れを実装することを強くお勧めします。アクセス トークンが期限切れになるたびに、ユーザーが資格情報を入力しなくて済むようになります。

OneNote Class Notebook アドイン統合のための API ガイドライン

適用対象: Office 365 のエンタープライズ ノートブック

このドキュメントでは、LMS でのクラスと割り当ての列挙、課題の設定、成績のダウンロードと更新のために OneNote で必要な API 呼び出しについて説明します。

要求はすべて認証される必要があります。要求はすべて HTTPS 経由で行う必要があります。

クラス一覧の取得

<Specify URL for retrieving list of classes> への GET 要求

現在の認証されたユーザーについて、LMS からクラスの JSON 配列が返されます。

各クラスのプロパティは次のとおりです。

プロパティ名説明
idstringLMS のインストール上で一意のクラスの識別子
namestring人が判読できるクラスの名前

クラス内の受講者一覧の取得

<Specify URL for retrieving list of students in a class> への GET 要求

LMS から、クラス内の受講者の JSON 配列が返されます。

各受講者のプロパティは次のとおりです。

プロパティ名説明
idstringLMS のインストール上で一意の受講者の識別子
namestring人が判読できる受講者の名前
emailstring受講者の電子メール アドレス

クラスの課題一覧の取得

<Specify URL for retrieving list of assignments for a class> への GET 要求

LMS から、クラス内の課題の JSON 配列が返されます。

プロパティ名説明
idstringLMS のインストール上で一意の課題の識別子
titlestring課題のタイトル
descriptionstring課題の説明。
gradetypeidstringLMS のインストール上で一意である成績の種類の識別子
dueDatedate as string (形式:2016-12-25T00:00:00)課題の期限LMS では、時刻の部分は使用また保存されません。
urlstring課題の URLサポートされている LMS バージョンでのみ使用できます。
省略可能なプロパティ名説明
gradetypeidstringLMS のインストール上で一意である成績の種類の識別子
mininteger受講者に割り当てることができる最低限のスコア
maxinteger受講者に割り当てることができる最大のスコア
validgradevalueslistこの課題の成績として有効な値

クラスへの課題の設定

<Specify URL for setting an assignment to a class> への POST 要求

次のフォーム POST 変数が必要です。

プロパティ名説明
titlestring (最大長:280)課題のタイトル
dueDatedate as string (形式:2016-12-25T00:00:00)課題の期限
descriptionstring課題の説明。
省略可能なプロパティ名説明
gradetypeidstringLMS のインストール上で一意である成績の種類の識別子
mininteger受講者に割り当てることができる最低限のスコア
maxinteger受講者に割り当てることができる最大のスコア
validgradevalueslistこの課題の成績として有効な値

LMS では、1 つの ID プロパティを使用して JSON オブジェクトが返されます。このプロパティの値は新たに設定する課題の識別子になります。

課題の成績一覧の取得

<Specify URL for retrieving grades for a given assignment> への GET 要求

LMS では、課題を受け取った受講者とその成績/スコアの JSON 配列が返されます。

各受講者の JSON セグメントのプロパティは次のとおりです。

プロパティ名説明
idstringLMS のインストール上で一意の受講者の識別子
emailstring受講者の電子メール アドレス
gradedboolean教師が点数を提供するかどうかを示します
obtainedMarkinteger受講者の点数 (任意) (例: 85)
maxMarkinteger満点の場合の点数 (任意) (例: 100)
feedbackstring受講者に返されるフィードバック (任意) (例: "よくできました")
gradestring受講者に返される成績 (任意) (例: "A")

LMS では、100 以外の数値の成績をサポートしています。そのような (maxMark が 100 ではない) 場合、OneNote では、OneNote のユーザー インターフェイスでこれを表示できなければ、obtainedMark を変換する必要があります。

受講者の成績の設定

<Specify URL for setting grade for a given student> への POST 要求

次のフォーム POST 変数が含まれます。

プロパティ名説明
idstring受講者用の guid 識別子
sourcestring常に値を " onenote" に設定
obtainedMarkinteger受講者の点数
maxMarkinteger可能な最高得点
obtainedGradestring受講者が取得した成績またはレベル (例:"A")
コメントstring受講者の自由書式のフィードバック

成績の種類の取得

<Specify URL for getting grade types> への GET 要求

LMS から、成績の種類の JSON 配列が返されます。各成績の種類のプロパティは次のとおりです。

プロパティ名説明
idstringLMS のインストール上で一意である成績の種類の識別子
gradeTypeCategoryGradeTypeCategoryLMS のインストール上で一意である成績の種類のカテゴリ
maxinteger最高得点
descriptionstring成績の種類の文字列を表示する

特定の成績の種類の取得

<Specify URL for getting grade type by id> への GET 要求

LMS から、次のプロパティを持つ単一の成績の種類の JSON が返されます。

プロパティ名説明
idstringLMS のインストール上で一意である成績の種類の識別子
gradeTypeCategoryGradeTypeCategoryLMS のインストール上で一意である成績の種類のカテゴリ
maxinteger最高得点
descriptionstring成績の種類の文字列を表示する

クラスを作成または削除し、割り当てを削除する API です。

これらは任意ですが、統合テストには使用することを強くお勧めします。Microsoft Class Notebook のチームでは、クリーンアップのためにこれらのエンドポイントを実行します。

enum GradeTypeCategory
{
        /// <summary>
        /// no grade type category.
        /// </summary>
        None,

        /// <summary>
        /// Numeric grade type category.
        /// </summary>
        Numeric,

        /// <summary>
        /// Percent grade type category.
        /// </summary>
        Percentage,

        /// <summary>
        /// Letter grade type category.
        /// </summary>
        Letters,
}

テスト環境の前提条件

テスト環境は 2 つのシステムで構成されます。

Office 365 テスト テナント

これはアクセス可能な Office 365 テナントにすることができます。Office ライセンスが有効ないくつかの教師アカウントと受講者アカウントがあります。デモ Office 365 テナントと呼ばれるものがあり、パートナーが利用できます。このデモ テナントを設定すると、教師、受講者、教育の SKU が事前入力されるカスタム K – 12 EDU インスタンスを選択することができます。

LMS のテスト環境とアカウント

Class Notebook チームに次の情報を提供する必要があります。

  • API エンドポイントをホストする LMS/SIS のベース URL。
  • アプリ ID* - クラス ノートブック アドインに割り当てられた一意のアプリ ID で、有効なアプリケーションとして検出するために使用します。
  • アプリ キー* - 指定されたアプリ ID のアプリ シークレット

*Oath2 をサポートしていない場合

マーケティング情報の前提条件

ロゴ画像

超高解像度である必要はありません。当社の現在のロゴは、実際にはサイズが 100 K 未満、最大 300 x 300 px までです。

説明

説明は、75 語までで (約 50 語が望ましい)、内容を簡潔に伝える必要があります

内容を詳細に説明するためのものです

64 x 64 ピクセルのロゴである必要があります

追加リソース

© 2018 Microsoft