WebSoc
The WebSoc (Web Schedule of Classes) endpoint allows programmatic access to the UCI Schedule of Classes.
Anteater API maintains a cache of all WebSoc data, which is updated every hour. By default, the endpoint will return data from the cache if it can, falling back to WebSoc on a cache miss. This improves the overall response time, but may result in stale data.
Query the Schedule of Classes
Query parameters
year
string Required
The year to query.
quarter
Fall | Winter | Spring | Summer1 | Summer10wk | Summer2 Required
The quarter to query. Case-sensitive.
cache
boolean
Whether to query the cache at all; defaults to true
. If this is set to false
, then the endpoint will query WebSoc directly instead. Note that disabling the cache for large queries may result in a timeout.
cacheOnly
boolean
Whether to use the cache exclusively; defaults to false
. If this is set to true
, then none of the following parameters marked with * are required, but cache misses will not result in a fallback query.
includeCoCourses
boolean
When querying by GE categories, the default behavior of WebSoc is to return only the main section of the course that satisfies the desired GE category. Setting this flag to true
also returns any co-courses (discussions, labs, etc.) associated with the main section, but requires cacheOnly
to also be set to true
.
To preserve backwards compatibility with WebSoc, this defaults to false
.
ge
* ANY | GE-1A | GE-1B | GE-2 | GE-3 | GE-4 | GE-5A | GE-5B | GE-6 | GE-7 | GE-8
The GE category code. Case-sensitive. Defaults to ANY.
department
* string
The department code.
sectionCodes
* string | string[]
The five-digit section code(s).
instructorName
* string
Any substring of the desired instructor's last name. To search an exact last name, append a comma to the parameter.
If cacheOnly
is false
, at least one of the parameters marked with * must be provided and must not be ANY.
building
string
The building code.
room
string
The room number.
If the room number is provided, the building code must be provided.
division
ANY | LowerDiv | UpperDiv | Graduate
The course level/division code. Case-sensitive. Defaults to ANY.
courseNumber
string | string[]
The course number(s) and/or range(s). (Ex.: 122A, 160-169)
courseTitle
string
Any substring of the course title.
sectionType
ANY | Act | Col | Dis | Fld | Lab | Lec | Qiz | Res | Sem | Stu | Tap | Tut
The section type code. Case-sensitive. Defaults to ANY.
units
string | string[]
The number(s) of units approved for the section and/or the string VAR
for any
section with variable units.
days
string | string[]
The day(s) that a section meets on. (Ex.: MWF
)
startTime
string
The time on or after which a section starts.
endTime
string
The time by which a section ends.
maxCapacity
string
The maximum capacity of a section. (Ex.: >200
, <21
, =69
)
fullCourses
ANY | SkipFull | SkipFullWaitlist | FullOnly | OverEnrolled
Which sections to exclude based on their enrollment status. Case-sensitive. Defaults to ANY.
cancelledCourses
Exclude | Include | Only
Which sections to exclude based on their cancellation status. Case-sensitive. Defaults to Exclude.
Code sample
Response
Section with no final exam
Section with TBA meeting time and final exam
Section with a final exam held in the same location as the lecture
Section with multiple meetings and final exam held in a different location
Get a list of available departments
Query parameters
None.
Response
Get a list of available departments
Query parameters
None.