divad12 / api-documentation

API Documentation for University of Waterloo API

![] (https://api.uwaterloo.ca/static/banner.png)

The University of Waterloo API allows anyone to build applications using data from the uWaterloo websites. The API currently features more than 30 methods of accessing various datasets accross the University network.

If you find an error in the documentation, file an issue or send a pull request.

License

• University of Waterloo Open Data Licensing (ODL) Agreement v1

Disclaimer

• Review the 'No Warranty' section of the University of Waterloo ODL before using this data. If building services upon this data, please inform your users of the inherent risks (as a best practice).

Accessing the API

All calls are made to the following URL with the required parameters for a given service.

https://api.uwaterloo.ca/v2/

In order to make an API call, you must have a valid API Key. The data is returned in json and xml where the output format can be specified in the request URL

Endpoints

Food Services

• /foodservices/menu
• /foodservices/notes
• /foodservices/announcements
• /foodservices/diets
• /foodservices/outlets
• /foodservices/locations
• /foodservices/watcard
• /foodservices/products/{product_id}
• /foodservices/{year}/{week}/menu
• /foodservices/{year}/{week}/notes
• /foodservices/{year}/{week}/announcements

Course

• /courses/{subject}
• /courses/{subject}/{catalog_number}
• /courses/{subject}/{catalog_number}/schedule
• /courses/{subject}/{catalog_number}/prerequisites
• /courses/{subject}/{catalog_number}/examschedule

Terms

• /terms/{term}/examschedule
• /terms/list

Resources

• /resources/printers
• /resources/infosessions

Definitions and Codes

• /codes/subjects
• /codes/groups
• /codes/units
• /codes/terms
• /codes/instructions

Building

• /buildings/list
• /buildings/{building_acronym}
• /buildings/{building_acronym}/{room_number}/courses

API

• /api/services
• /api/methods
• /api/usage
• /api/versions
• /api/changelog

Server

• /server/time
• /server/codes

Contributing

If you would like to offer your suggestions or report any misfindings regarding the API data, simply create a new issue on the issues tab of the OpenData Repository and assign it an appropriate label.

Categories

• Bug
• Enhancement
• Question
• Data Request

Restrictions

Usage

Currently, the API requests are restricted to 25,000 calls per month for a given key. This number may increase in the future.

If your implementation of the API requires additional requests, feel free to contact us regarding the removal of your limit.

Data

The intent of data offered through this API is limited to publicly visible data only. Private data such as student specific information is out of the API's scope.

Contact

If you have any inquiries or suggestions, please feel free to contact us at [e-mail].

Please consider subscribing to our mailing list in order to receive updates on the API and follow discussions.