You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Multiple: /api/courses/v0/courses/
Returns a list of JSON representations of courses in the edX Platform, constrained by organization.
Single: /api/courses/v0/courses/{course_id}/
Returns the JSON representation for a single course
Available Query Parameters
Parameter | Type | Values | Required | Default | Notes |
---|
org | string | various | no | | |
display | string | brief | full | no | brief (multi), full (single) | |
course_id | csv | strings | no | | |
include_fields | csv | strings | no | | Request additional fields, returns null for fields not found |
page | integer | 1-N | no | 1 | Django REST Framework parameter |
page_size | integer | 1-N | no | 20 | Django REST Framework parameter |
pacing | string | strings | no | | Request only courses with the specified pacing |
mode | string | strings | no | | Request only courses with specific modes |
subject | string | strings | no | | Request only courses on specific subjects |
Detailed Examples
Note: for a complete list of available fields, see Course Discovery API: RESTful Field Specification
GET /api/courses/v0/courses/?page_size=1
{ "count": 2, "next": "http://0.0.0.0:8000/api/course_metadata/v0/courses/?org=edX&page=2&page_size=1, "previous": null, "num_pages": 2, "results": [ { "uri": "http://0.0.0.0:8000/api/course_metadata/v0/courses/MITx/4.605x_2/3T2014/", "id": "MITx/4.605x_2/3T2014", "org": "MITx", "course": "4.605x_2", "run": "3T2014", "name": "A Global History of Architecture: Part 1", "start_date": "2014-09-23T14:00:00Z", "end_date": "2014-12-11T05:00:00Z", "short_description": "This is the short description for the edX Demonstration Course", "video_url": "http://media.edx.org/courses/edX/Demo/Course/videos/promo.mov", "image_url": "http://media.edx.org/courses/edX/Demo/Course/images/promo.png", "purchase_url": "http://shop.edx.org/courses/edX/Demo/Course/purchase" "due": null, "staff":[ { "name": "Professor Smith", "image_url": "http://media.edx.org/courses/edX/Demo/Course/images/smith.png", "description": "Professor Smith is the lead researcher for this topic." }, { "name": "Assistant Ben", "image_url": "http://media.edx.org/courses/edX/Demo/Course/images/ben.png", "description": "Assistant Ben does a lot of the day-to-day work." } ], "prices": { "US": "999.00", "GB": "649.00" } }, {...} ] } |
GET /api/courses/v0/courses/MITx/4.605x_2/3T2014/
{ "uri": "http://0.0.0.0:8000/api/course_metadata/v0/courses/MITx/4.605x_2/3T2014/", "id": "MITx/4.605x_2/3T2014", "org": "MITx", "course": "4.605x_2", "run": "3T2014", "name": "A Global History of Architecture: Part 1", "start_date": "2014-09-23T14:00:00Z", "end_date": "2014-12-11T05:00:00Z", "short_description": "This is the short description for the edX Demonstration Course", "video_url": "http://media.edx.org/courses/edX/Demo/Course/videos/promo.mov", "image_url": "http://media.edx.org/courses/edX/Demo/Course/images/promo.png", "purchase_url": "http://shop.edx.org/courses/edX/Demo/Course/purchase" "due": null, "staff":[ { "name": "Professor Smith", "image_url": "http://media.edx.org/courses/edX/Demo/Course/images/smith.png", "description": "Professor Smith is the lead researcher for this topic." }, { "name": "Assistant Ben", "image_url": "http://media.edx.org/courses/edX/Demo/Course/images/ben.png", "description": "Assistant Ben does a lot of the day-to-day work." } ], "prices": { "US": "999.00", "GB": "649.00", } } |