For Developers

Courses Overview

A Course is a plan of study. Most of the time, many Classes of a single Course are taught in the same Session.

For example, a school offers a Data Structures & Algorithms Course. There might be several Classes of that course, each with a different teacher and a different set of students enrolled in it.

You might imagine that a Course would be found in your university's course listing, whereas a Class or Section would be what you actually Enrolled in during the class registration period.

In previous versions of the Edlink API, Course had a different meaning. That meaning has been adapted to the Class object.

In v2.0, we've corrected some of our terminology to be more accurate and universal. Please review Migration from v1.0 for more information.

Properties

PropertyTypeDescription
idstringThe UUID for the object.
$filter operators: equals in not in
created_dateDateWhen the object was first seen by Edlink.
updated_dateDateWhen the object was last changed in Edlink.
$filter operators: equals gt lt gte lte
namestringThe name of the object.
codestringThe course code.
$filter operators: equals in not in is known is unknown
grade_levelsGradeLevel[]The grade levels this course is associated with.
subjectsSubject[](Deprecated in favor of subject_id) The subjects this course is associated with.
propertiesobjectNon-standard properties that may be of interest to the developer.
identifiersIdentifier[]Additional IDs associated with the object.
session_idstringThe UUID of the associated Session. $filter operators: equals in not in
school_idstringThe UUID of the associated School.
$filter operators: equals in not in
district_idstringThe UUID of the associated District.
department_idstringThe UUID of the associated Department. $filter operators: equals in not in
subject_idstringThe UUID of the associated Subject. $filter operators: equals in not in

JSON Example

{
    "id": "00000000-0000-0000-0000-000000000000",
    "created_date": "2021-07-13T17:45:27.570Z",
    "updated_date": "2021-07-13T17:45:27.570Z",
    "name": "Data Structures & Algorithms",
    "code": "CS 425",
    "grade_levels": [],
    "subjects": ["CEDS.21"],
    "properties": {},
    "session_id": "00000000-0000-0000-0000-000000000000",
    "school_id": "00000000-0000-0000-0000-000000000000",
    "district_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "subject_id": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

ProviderSupport