REST API Resources

SCHEDULE

The schedule module shows available subjects, courses and sections for a given year and semester. A subject will be visible if it has courses. A course will be visible if it has sections.

Resource	Description
GET schedule	Returns links to the resources for each year available in the schedule. This is the root of the schedule context.
GET schedule/:year	Returns links to the resources for each term available scheduled for the given year.
GET schedule/:year/:semester	Returns links to the resources for each subject available scheduled for the given year and semester.
GET schedule/:year/:semester/:subject	Returns links to the resources for each course available in the course catalog for the given year, semester, and subject.
GET schedule/:year/:semester/:subject/:course	Returns links to the resources for each section available scheduled for the given year, semester, subject, and course.
GET schedule/:year/:semester/:subject/:course/:crn	Returns details of the specified section scheduled for the given year, semester, subject, course, and CRN. The crn is the Course Registration Number for the section as it appears in Banner.
GET schedule/courses	Returns courses that match the criteria given by the query parameters.
GET schedule/sections	Returns sections that match the criteria given by the query parameters. Results are returned either in XML or ICS (iCalendar) format.
GET schedule/sessions/:year/:semester	Returns the sessions (subdivisions of a semester) for the given year and semester.

CATALOG

The catalog module shows subjects and courses that are currently available, or have been previously available. A subject is visible if it has or had courses available. A course is available if it is currently or has been previously offered.

Resource	Description
GET catalog	Returns links to the resources for each year available in the course catalog. This is the root of the schedule context.
GET catalog/:year	Returns links to the resources for each semester available in the course catalog for the given year.
GET catalog/:year/:semester	Returns links to the resources for each subject available in the course catalog for the given year and semester.
GET catalog/:year/:semester/:subject	Returns links to the resources for each course available in the course catalog for the given year, semester, and subject
GET catalog/:year/:semester/:subject/:course	Returns links to the information for a course in the course catalog course catalog for the given year, semester, subject, and course number.

GENED

The gened module shows general education requirements and courses that fulfill those requirements.

Resource	Description
GET gened	Returns links to the resources for each year available for General Education Requirements. This is the root of the gened context.
GET gened/:year	Returns links to the resources for each semester available for General Education Requirements given the year.
GET gened/:year/:semester	Returns links to all the General Education category resources available for the given year and semester.
GET gened/:year/:semester/:category	Returns links to all the General Education subcategory resources available for the given year, semester, and selected category.
GET gened/:year/:semester/:category/:subcategory	Returns links to all the General Education resources for a specific subcategory available for the given year, semester, category, and selected subcategory.

TERM

The term module provides edit and view capabilities to authorized users for the terms that are available in the CIS.

Resource	Description
PUT term	Used update a term's public indicator and archive indicator. Users must be authorized for this method.
GET term/:year	Retrieve term details for the given year.
GET term/:year/:semester	Retrieve term details for the given year and semester.

SUBJECTS

The subjects module provides header information edit and view capabilities to authorized users for the subjects that are available in the CIS.

Resource	Description
PUT headers	Used update a subject's header information. Users must be authorized for this method.
GET subjects/:year/:semester/:subject	Retrieve subject details for the given year, term and subject.