Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Course Metadata Endpoint, Multiple

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"
}
},
 {...}
 ]
}

 

Course Metadata Endpoint, Single

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",
}

 

Complete Field List

xxxxxxxx
FieldTypeBriefFullv0Notes
uristringxxFully-qualified URL for the Course About page
course_idstringxxxFull course identifier (opaque key)
orgstringxxx 
coursestringxxx 
course_familystringxxCombines org and course into a key that can be matched across runs
runstringxx 
namestringxx 
startdatetimexxx 
enddatetimexxx 
short_descriptionstringxxx 
mediadictxxx 
media.xxxxxdictxxEx: ''video', 'image'
media.xxxxx.uristringxxx 
media.xxxxx.namestringxxx 
media.xxxxx.descriptionstringxxx 
media.xxxxx.typestringxxxEx: 'youtube', 'brightcove'
staffarrayxxx 
staff[n].namestringxx 
staff[n].uristringxx 
staff[n].mediadict xx 
staff[n].media.xxxxxdict xxEx: 'video', 'image'
staff[n].media.xxxxx.uristring xx 
staff[n].media.xxxxx.name

string

 xx 
staff[n].media.xxxxx.descriptionstring xx 
staff[n].media.xxxxx.typestring xxEx: 'youtube', 'large'
priceintxxPrice of the course in US dollars
subjectsarray  xx 
subjects[n].titlestring x 
subjects[n].uristring x 
subjects[n].languagestring x 
leveldict x 
level.titlestring x 
level.uristring xx 
languagesarray x 
languages.xxdict x 
languages.xx.titlestring x 
languages.xx.uristring xx 
pacingstringxxxInstructor led, self-paced, etc
xseriesstringxxxWhich Xseries this course is a part of, if any
lengthstring xx 
effortstring xx 
prerequisitesstring xx