eden APIドキュメント (0.1.3)

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/lesson/{レッスンセクションのID}

path Parameters

courseid required	integer コースのID
materialkind required	string Enum: "lesson" "test" "compoundtest" "form" "writing" "facetoface" コンテンツの種別 lesson レッスンセクション test テストセクション compoundtest 複合テスト form フォームセクション writing 添削課題セクション facetoface 対面研修セクション
materialid required	integer コンテンツ（セクション、または複合テスト）のID

Responses

Response samples

Content type

application/json

[{"user": {"id": 0,
"userid": "string",
"name": "string",
"locked": true,
"language": "",
"usergroups": [{"id": 0,
"name": "string",
"folderid": 0
}
],
"folder": {"id": 0,
"name": "string",
"folderid": 0,
"folderid_full_path": "string"
},
"mailaddress": "string"
},
"completed": true,
"display_status": "string",
"completed_at": "string",
"last_accessed_at": "string"
}
]

Models

LessonSectionLearningRecordSummary

レッスンセクション学習状況

point	integer 完了率
total_page_count	integer セクション内のページ数
	object 完了したページとその日時
	object 各ページごとの滞在時間（秒）
	object (User) ユーザー
completed	boolean 学習完了しているかどうか
display_status	string 学習状態を示すヒューマンリーダブルな文字列
completed_at	string 学習完了した日時
last_accessed_at	string 最終アクセス日時

{"point": 0,
"total_page_count": 0,
"cleared_pages": {"property1": "string",
"property2": "string"
},
"session_durations": {"property1": 0,
"property2": 0
},
"user": {"id": 0,
"userid": "string",
"name": "string",
"locked": true,
"language": "",
"usergroups": [{"id": 0,
"name": "string",
"folderid": 0
}
],
"folder": {"id": 0,
"name": "string",
"folderid": 0,
"folderid_full_path": "string"
},
"mailaddress": "string"
},
"completed": true,
"display_status": "string",
"completed_at": "string",
"last_accessed_at": "string"
}

TestMaterialLearningRecordSummary

テストセクションまたは複合テストの学習状況

point	integer 最高得点
	object (User) ユーザー
completed	boolean 学習完了しているかどうか
display_status	string 学習状態を示すヒューマンリーダブルな文字列
completed_at	string 学習完了した日時
last_accessed_at	string 最終アクセス日時

{"point": 0,
"user": {"id": 0,
"userid": "string",
"name": "string",
"locked": true,
"language": "",
"usergroups": [{"id": 0,
"name": "string",
"folderid": 0
}
],
"folder": {"id": 0,
"name": "string",
"folderid": 0,
"folderid_full_path": "string"
},
"mailaddress": "string"
},
"completed": true,
"display_status": "string",
"completed_at": "string",
"last_accessed_at": "string"
}

FormSectionLearningRecordSummary

フォームセクション学習状況

status	string 状態 not-attempted 未着手 draft 下書き中 submitted 提出済
	object (User) ユーザー
completed	boolean 学習完了しているかどうか
display_status	string 学習状態を示すヒューマンリーダブルな文字列
completed_at	string 学習完了した日時
last_accessed_at	string 最終アクセス日時

{"status": "string",
"user": {"id": 0,
"userid": "string",
"name": "string",
"locked": true,
"language": "",
"usergroups": [{"id": 0,
"name": "string",
"folderid": 0
}
],
"folder": {"id": 0,
"name": "string",
"folderid": 0,
"folderid_full_path": "string"
},
"mailaddress": "string"
},
"completed": true,
"display_status": "string",
"completed_at": "string",
"last_accessed_at": "string"
}

WritingSectionLearningRecordSummary

添削課題セクション学習状況

status	string 状態 not-attempted 未着手 draft 下書き中 rejected 要再提出 submitted 提出済 correcting 添削中 reopened 添削修正中 corrected 添削済
point	integer 得点
	object (User) ユーザー
completed	boolean 学習完了しているかどうか
display_status	string 学習状態を示すヒューマンリーダブルな文字列
completed_at	string 学習完了した日時
last_accessed_at	string 最終アクセス日時

{"status": "string",
"point": 0,
"user": {"id": 0,
"userid": "string",
"name": "string",
"locked": true,
"language": "",
"usergroups": [{"id": 0,
"name": "string",
"folderid": 0
}
],
"folder": {"id": 0,
"name": "string",
"folderid": 0,
"folderid_full_path": "string"
},
"mailaddress": "string"
},
"completed": true,
"display_status": "string",
"completed_at": "string",
"last_accessed_at": "string"
}

FaceToFaceLearningRecordSummary

対面研修セクション学習状況

status	string 状態 not-attempted 未受講 incomplete 未完了 completed 完了
point	integer 得点
memo	string メモ
	object (User) ユーザー
completed	boolean 学習完了しているかどうか
display_status	string 学習状態を示すヒューマンリーダブルな文字列
completed_at	string 学習完了した日時
last_accessed_at	string 最終アクセス日時

{"status": "string",
"point": 0,
"memo": "string",
"user": {"id": 0,
"userid": "string",
"name": "string",
"locked": true,
"language": "",
"usergroups": [{"id": 0,
"name": "string",
"folderid": 0
}
],
"folder": {"id": 0,
"name": "string",
"folderid": 0,
"folderid_full_path": "string"
},
"mailaddress": "string"
},
"completed": true,
"display_status": "string",
"completed_at": "string",
"last_accessed_at": "string"
}