banner/docs/README.md

Documentation

This folder contains detailed documentation for the Banner project. This file acts as the index.

Files

• CHANGELOG.md - Notable changes by version
• ROADMAP.md - Planned features and priorities
• BANNER.md - General API documentation on the Banner system
• ARCHITECTURE.md - Technical implementation details, system design, and analysis

Samples

The samples/ folder contains real Banner API response examples:

• search/ - Course search API responses with various filters
  • searchResults.json
  • searchResults_500.json
  • searchResults_CS500.json
  • searchResults_malware.json
• meta/ - Metadata API responses (terms, subjects, instructors, etc.)
  • get_attribute.json
  • get_campus.json
  • get_instructionalMethod.json
  • get_instructor.json
  • get_partOfTerm.json
  • get_subject.json
  • getTerms.json
• course/ - Course detail API responses (HTML and JSON)
  • getFacultyMeetingTimes.json
  • getClassDetails.html
  • getCorequisites.html
  • getCourseDescription.html
  • getEnrollmentInfo.html
  • getFees.html
  • getLinkedSections.html
  • getRestrictions.html
  • getSectionAttributes.html
  • getSectionBookstoreDetails.html
  • getSectionPrerequisites.html
  • getXlistSections.html

These samples are used for development, testing, and understanding the Banner API structure.