Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
340 lines (308 loc) · 7.08 KB

course_id.md

File metadata and controls

340 lines (308 loc) · 7.08 KB

Course Information (by course_id)

GET /courses/{course_id}.{format}

Description

This method returns all available information for a given course

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1153 Enabled Yes
Service Name courses Service ID 239
Information Steward Registrar Data Type Scraped/API DB
Update Frequency Every request (live) Cache Time 0 seconds

Notes

  • The course_id does not have to be left-padded with zeros
  • Any value can be null

Sources

Parameters

GET /courses/{course_id}.{format}
Parameter Type Required Description
subject input yes Valid uWaterloo subject name
catalog_number input yes Valid uWaterloo course number
format input yes The format of the output
key filter yes Valid API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /courses/{course_id}.{format}

Response

Field Name Type Value Description
course_id string Registrar assigned course ID
subject string Requested subject acronym
catalog_number string Registrar assigned class number
title string Class name and title
units number Credit count for the mentioned course
description string Brief course description
instructions list Instruction types for the course (LEC, TUT, LAB etc)
prerequisites string Prerequisite listing for the course
antirequisites string Antirequisite listing for the course
corequisites string Corequisite listing for the course
crosslistings string Crosslisted courses
terms_offered list List of terms that the course is offered
notes string Additional notes on the course
offerings object Brief course description
online boolean Is the course offered online
online_only boolean Is the course only offered online
st_jerome boolean Is the course offered at St. Jerome's
st_jerome_only boolean Is the course only offered at St. Jerome's
renison boolean Is the course offered at Renison
renison_only boolean Is the course only offered at Renison
conrad_grebel boolean Is the course offered at Conrad Grebel
conrad_grebel_only boolean Is the course only offered at Conrad Grebel
needs_department_consent boolean Does enrollment require the department's permission
needs_instructor_consent boolean Does enrollment require instructor's consent
extra list Any additional information associated with the course
calendar_year string Last active year the course was offered
url string Course URL on the course calendar
academic_level string Undergraduate or graduate course classification

Any value can be null

Output

JSON

{
  "meta":{
    "requests":305,
    "timestamp":1384537490,
    "status":200,
    "message":"Request successful",
    "method_id":1153,
    "version":2.07,
    "method":{
      
    }
  },
  "data":{
    "course_id":"007407",
    "subject":"PHYS",
    "catalog_number":"234",
    "title":"Quantum Physics 1",
    "units":0.5,
    "description":"Background of quantum physics. Quantization, waves and particles. The uncertainty principle. The Schroedinger equation for one-dimensional problems: bound states in square wells. Harmonic oscillator; transmission through barriers.",
    "instructions":[
      "LEC",
      "TUT"
    ],
    "prerequisites":"PHYS 112 or 122; MATH 114 or 136; MATH 128 or 138 or 148; One of MATH 228, AMATH 250, AMATH 251.",
    "antirequisites":"CHEM 256\/356, NE 232",
    "corequisites":"MATH 228 or AMATH 250.",
    "crosslistings":null,
    "terms_offered":[
      "W",
      "S"
    ],
    "notes":"[Note: PHYS 236 or knowledge of computational methods recommended. Offered: W, S]",
    "offerings":{
      "online":false,
      "online_only":false,
      "st_jerome":false,
      "st_jerome_only":false,
      "renison":false,
      "renison_only":false,
      "conrad_grebel":false,
      "conrad_grebel_only":false
    },
    "needs_department_consent":false,
    "needs_instructor_consent":false,
    "extra":[
      
    ],
    "calendar_year":"1415",
    "url":"http:\/\/www.ucalendar.uwaterloo.ca\/1415\/COURSE\/course-PHYS.html#PHYS234",
    "academic_level":"undergraduate"
  }
}