This is an old revision of the document!


/api/courses

HEAD, GET

List courses using the filters set as parameters. The number of courses is represented in the X-Count header - use the HEAD request to simply count the number of courses matching the filters. Use the GET request to actually fetch them.

Syntax

GET /api/courses
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name Description Notes
byStatuses Optional List of statuses, currently limited to: Online,Standby,Draft,Archived,Template,Closed [1]
byTypes Optional List of course types [1]
byModes Optional List of course modes [1]
  • Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators - in other words an institution is considered matching if it matches to any of the values in the list.

Response headers

Content-Type: application/json
Content-Length: 1456
X-Count: 123