This application implements an API service for submitted schedules, and a temporary API service for course listing. The former is a generic service that can be used to retrieve user schedule collected from the schedule collection page in this application. The later API retrieves the course schedule for courses imported via the ‘import course’ utility from this application. It will be replaced by the courses API from ITS when that becomes available.
Both APIs are open services. No authentication is required to access.
The Schedule API Service
The schedules API service is tied to a site. The endpoint URL is
https://schedule.ma.utexas.edu/SITE/wp-json/math-agenda/v1/get
The following parameters can be used.
- eid: specify the eid of the person for whom the schedule to be retrieved
- id: specify the id of the specific schedule entry. If specified, no other parameter is needed. They’ll be ignored if specified.
- ccyys: specify the semester year.
- pid: specify the id of the page that is used to collect the schedule. If multiple schedule collection page is used, this parameter is need to fetch the correct schedule.
- grid: if multiple grid is used on a schedule collection page, this parameter let you fetch the schedule submitted from the specified grid.
For example,
https://schedule.ma.utexas.edu/math/wp-json/math-agenda/v1/get?eid=mzou
retrieves all schedules submitted by mzou on the math TA scheduler site; and
https://schedule.ma.utexas.edu/math/wp-json/math-agenda/v1/get?eid=mzou&ccyys=20199
retrieves mzou’s schedule for the Fall 2019 semester.
This API also contains a set of POST endpoints for manipulating the schedule. They requires authentication to access.
The Course API Service
The endpoint URL for the courses listing API is
https://schedule.ma.utexas.edu/wp-json/math-courses/v1/get
The following parameters can be provided.
- ccyys: specify the semester year. This parameter must be present in order to retrieve any meaningful results (unique number is only unique within a semester).
- unique: specify the unique number. If specified, the next parameter is ignored.
- fos: specify the field of study. This is used to list all courses within of a field.
For example,
https://schedule.ma.utexas.edu/wp-json/math-courses/v1/get?ccyys=20199
lists all Fall 2019 courses in the system.
https://schedule.ma.utexas.edu/wp-json/math-courses/v1/get?ccyys=20199&unique=52215
lists the schedule of the Fall 2019 course with unique number 52215.