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

Latest commit

 

History

History
415 lines (383 loc) · 8.5 KB

class_number_schedule.md

File metadata and controls

415 lines (383 loc) · 8.5 KB

Course Schedule by Class Number

GET /courses/{class_number}/schedule.{format}

Description

This method returns the class schedule for a given course and term

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1163 Enabled Yes
Service Name courses Service ID 239
Information Steward Registrar Data Type Scraped
Update Frequency Every hour Cache Time 0 seconds

Notes

  • By default, only schedules for the current term will be returned if the term parameter is not given
  • Any value can be null

Sources

Parameters

GET /courses/{class_number}/schedule.{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
term filter no Four digit term representation
key filter yes Valid API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /courses/{class_number}/schedule.{format}

Response

Field Name Type Value Description
subject string Requested subject acronym
catalog_number string Registrar assigned class number
units number Credit count for the mentioned course
title string Class name and title
note string Additional notes regarding enrollment for the given term
class_number integer Associated term specific class enrollment number
section string Class instruction and number
campus string Name of the campus the course is being offered
associated_class integer Associated class id
related_component_1 string Name of the related course component
related_component_2 string Name of the second related course component
enrollment_capacity integer Class enrollment capacity
enrollment_total integer Total current class enrollment
waiting_capacity integer Class waiting capacity
waiting_total string Total current waiting students
topic string Class discussion topic
reserves object Course specific enrollment reservation data
reserve_group string Name of the reserved group
enrollment_capacity integer Total enrollment capacity of the group
enrollment_total integer Total reserve enrollment
classes object Schedule data
date object Date object for course schedule
start_time string 24 hour class starting time
end_time string 24 hour class ending time
weekdays string Weekdays the course is offered
start_date string Additional starting date for course
end_date string Additional ending date for course
is_tba boolean If the course schedule is TBA
is_cancelled boolean If the course is cancelled for the term
is_closed boolean If the course is closed for the term
location object Class location details
building string Name of the building
room string Room number from the building
instructors list Names of instructors teaching the course
held_with list A list of classes the course is held with
term integer 4 digit term representation
academic_level string Undergraduate or graduate course classification
last_updated string ISO8601 timestamp of when the data was last updated

Any value can be null

Output

JSON

{
  "meta":{
    "requests":475,
    "timestamp":1384890021,
    "status":200,
    "message":"Request successful",
    "method_id":1163,
    "version":2.07,
    "method":{
      "disclaimer":"Review the 'No Warranty' section of the University of Waterloo Open Data License before using this data. If building services upon this data, please inform your users of the inherent risks (as a best practice)",
      "license":"https:\/\/uwaterloo.ca\/open-data\/university-waterloo-open-data-license-agreement-v1"
    }
  },
  "data":[
    {
      "subject":"CS",
      "catalog_number":"486",
      "units":0.5,
      "title":"Introduction to Artificial Intelligence",
      "note":null,
      "class_number":5377,
      "section":"LEC 001",
      "campus":"UW U",
      "associated_class":1,
      "related_component_1":null,
      "related_component_2":null,
      "enrollment_capacity":85,
      "enrollment_total":77,
      "waiting_capacity":0,
      "waiting_total":0,
      "topic":null,
      "reserves":[
        
      ],
      "classes":[
        {
          "dates":{
            "start_time":"16:00",
            "end_time":"17:20",
            "weekdays":"TTh",
            "start_date":null,
            "end_date":null,
            "is_tba":false,
            "is_cancelled":false,
            "is_closed":false
          },
          "location":{
            "building":"MC",
            "room":"4045"
          },
          "instructors":[
            "Larson,Kate"
          ]
        }
      ],
      "held_with":[
        "CS 686"
      ],
      "term":1139,
      "academic_level":"undergraduate",
      "last_updated":"2013-11-19T14:00:46-05:00"
    }
  ]
}