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

[アーティクル]
04/13/2017

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

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

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

注意

各 LMS は、oauth2 実装のフローを許可する認証コードを実装することをお勧めします。これにより、ユーザーがアクセストークンの有効期限が切れるたびに資格情報を入力するという面倒な作業が不要になります。

クラスの一覧を取得します。

GET へ要求<Specify URL for retrieving list of classes>します。

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

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

プロパティ名	型	説明
ID	文字列	LMS のインストール上で一意のクラスの識別子
名前	文字列	人が判読できるクラスの名前

クラスで受講者のリストを取得します。

GET へ要求<Specify URL for retrieving list of students in a class>します。

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

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

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

クラスの割り当ての一覧を取得します。

GET へ要求<Specify URL for retrieving list of assignments for a class>します。

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

プロパティ名	型	説明
ID	文字列	LMS のインストール上で一意の課題の識別子
件名	文字列	課題のタイトル
説明	文字列	課題の説明
gradetypeid	文字列	LMS のインストール上で一意である成績の種類の識別子
期限	文字列としてのデータ (形式:2016-12-25T00:00:00)	課題の期限 LMS は、時刻の部分を格納したり使用したりできません。
URL	文字列	課題の URL。サポートされている LMS バージョンでのみ使用できます。

省略可能なプロパティ名	型	説明
gradetypeid	文字列	LMS のインストール上で一意である成績の種類の識別子
最小	整数	受講者に割り当てることができる最低限のスコア
最大	整数	受講者に割り当てることができる最大のスコア
validgradevalues	リスト	この課題の成績として有効な値

クラスへの割り当てを設定する

POST へ要求<Specify URL for setting an assignment to a class>します。

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

プロパティ名	型	説明
件名	string (最大長:280)	課題のタイトル
期限	date as string (形式:2016-12-25T00:00:00)	課題の期限
説明	文字列	課題の説明

省略可能なプロパティ名	型	説明
gradetypeid	文字列	LMS のインストール上で一意である成績の種類の識別子
最小	整数	受講者に割り当てることができる最低限のスコア
最大	整数	受講者に割り当てることができる最大のスコア
validgradevalues	リスト	この課題の成績として有効な値

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

課題の成績の一覧を取得する

GET へ要求<Specify URL for retrieving grades for a given assignment>します。

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

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

プロパティ名	型	説明
ID	文字列	LMS のインストール上で一意の受講者の識別子
電子メール	文字列	受講者の電子メールアドレス
評定済み	ブール値	教師が点数を提供するかどうかを示します
obtainedMark	整数	受講者の点数 (任意) (例: 85)
maxMark	整数	満点の場合の点数 (任意) (例: 100)
フィードバック	文字列	受講者に返されるフィードバック (任意) (例: "よくできました")
成績	文字列	受講者に返される成績 (任意) (例: "A")

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

受講者の成績を設定します。

POST へ要求<Specify URL for setting grade for a given student>します。

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

プロパティ名	型	説明
ID	文字列	受講者用の guid 識別子
ソース	文字列	常に値を onenote に設定する" ****"
obtainedMark	整数	受講者の点数
maxMark	整数	可能な最高得点
obtainedGrade	文字列	受講者が取得した成績またはレベル (例:"A")
コメント	文字列	受講者への自由書式のフィードバック

成績の種類の取得

GET へ要求<Specify URL for getting grade types>します。

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

プロパティ名	型	説明
ID	文字列	LMS のインストール上で一意である成績の種類の識別子
gradeTypeCategory	GradeTypeCategory	LMS のインストール上で一意である成績の種類のカテゴリ
最大	整数	有効最大スコア
説明	文字列	成績の種類の文字列を表示する

特定のクラス型を取得する

GET へ要求<Specify URL for getting grade type by id>します。

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

プロパティ名	型	説明
ID	文字列	LMS のインストール上で一意である成績の種類の識別子
gradeTypeCategory	GradeTypeCategory	LMS のインストール上で一意である成績の種類のカテゴリ
最大	整数	有効最大スコア
説明	文字列	成績の種類の文字列を表示する

課題を作成、削除、または割り当てを削除する

これらは、任意ですが、統合テストのために強く推奨します。 Microsoft クラスのノートブックのチームでは、クリーンアップのためにこれらのエンドポイントを実行します。

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 テナントのデモは、パートナーが利用できます。このデモのテナントをセットアップする場合、ことができますカスタム K–は、先生と生徒と教育の Sku では、あらかじめ設定されている 12 の EDU インスタンスです。
LMS のテスト環境とアカウント

Class Notebook チームに次の情報を提供する必要があります。
- API エンドポイントをホストする LMS/SIS のベース URL。
- アプリケーション ID (Oauth2 をサポートしていない場合) : クラスのノートブックアドインの有効なアプリケーションとして検出するために割り当てられた、一意のアプリケーション ID です。
- アプリケーションキー(Oauth2 をサポートしていない場合): 指定されたアプリケーション ID のアプリケーションシークレット

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

ロゴのイメージ スーパー高解像度にする必要はありません。当社の現在のロゴは、実際には 100 K 未満のサイズと最大 300 x 300 ピクセルが最大です。
説明：説明は、75 語までで (約 50 語が望ましい)、内容を簡潔に伝える必要があります
Web サイトへのリンク** ** 内容を詳細に説明するためのものです
ボタンのロゴ 64 x 64 ピクセルのロゴである必要があります。

次の方法で共有