eden APIドキュメント (0.1.2)

Download OpenAPI specification:Download

edenを外部サービスと連携させるためのAPI仕様についてのドキュメントです。(現在ベータ版のため、今後仕様が変更される可能性が高いことをご了承ください)

Authentication

ApiKeyAuth

「token accesskey secretkey」の形式

Security Scheme Type API Key
Header parameter name: Authorization

General

指定したコンテンツの詳細な学習結果を取得

指定したコンテンツの詳細な学習結果一覧を取得します。たとえばテストセクションの学習結果を取得する場合は以下のURLとなります。
/course/{コースのID}/summary/test/{テストセクションのID}

path Parameters
courseid
required
integer

コースID

materialkind
required
string
Enum: "test" "compoundtest" "form"

コンテンツの種別

  • test テストセクション
  • compoundtest 複合テスト
  • form フォームセクション
materialid
required
integer

教材ID

query Parameters
userids
string

取得したいユーザーID(複数指定する場合はカンマ区切り ex: demo1@eden.ac,demo2@eden.ac )

Responses

Response samples

Content type
application/json
{
  • "items": {
    }
}