Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 876 Bytes

README.md

File metadata and controls

34 lines (21 loc) · 876 Bytes
Raw

banner-api

Interface between CourseShark server and Banner API given to us by Georgia Tech

The API to the Banner endpoints provided by Georgia Tech's OIT department for courseshark.

Testing

make test

Usage

Authentication

.authenticate(type, options)

Call .authenticate with a string then an object of settings

var bannerAPI = require('banner-api')
banner = bannerAPI('https://api.gatech.edu/apiv3/central.academics.course_catalog.{resource}/search');
banner.authenticate('password', {
    app_id: process.env.NODE_GTAPI_ID
  , app_password: process.env.NODE_GTAPI_PASSWORD
})

Terms

.getTerms(options, callback)

Used to get a list of terms with optional parameters

Subjects

.getSubjects(termCode, callback) or .getDepartments(termCode, callback)