Skip to main content

Object and attribute meaning

Course​

Object​

course: {
id: 12,
	name: ‘Vector Calculus 101’,
	code: ‘VC101’
}

Description​

The template that defines shared information (e.g. name, code) for course-offerings. Serves as the base for a PlannedCourse. A PlannedCourse can be linked to only one Course.

Example: The course “Mathematics 101” will be offered in fall and spring. The Course would be “Mathematics 101”, there will be two PlannedCourses, one for the fall edition, one for the spring edition.

API endpoint​

Index: <subdomain>.eduframe.nl/api/v1/courses Show: <subdomain>.eduframe.nl/api/v1/courses/<:id>

Available events for webhook​

  • course.created
  • course.deleted
  • course.updated

PlannedCourse​

Object​

planned_course: {
id: 42,
	course_id: 12,
type: ‘FixedPlannedCourse’,
	start_date: ‘2017-04-22’,
	end_date: ‘2018-04-22’,
	duration_in_days: 365,
	status: ‘completed’
}