Giter VIP home page Giter VIP logo

infinite-campus's Introduction

Infinite Campus API

npm version

install with npm i infinite-campus

(full docs here)

This project (although in a stable state) is in desperate need of new maintainers!!! If you are interested in testing new PR's please contact me :-)

Super easy to use!

const InfiniteCampus = require('infinite-campus')
// log in                          District Name    State  Username  Password
const user = new InfiniteCampus('New York District', 'NY', 'JDoe12', 'XXXXXX')

// wait until we are done logging in
user.on('ready', () => {
  // now that we are logged in...
  
  // get grades from all courses, returns an array of terms containing class information (see docs)
  user.getCourses().then((terms) => {
    console.log(terms)
    // [{name:"Q1", courses: [{name: "1 English", grades:{}, ...}, ...]}, ... ]
  })
  
  // get the last 20 notifications
  user.getNotifications(20).then((notifications) => {
    console.log(notifications)
    // [{id: "1111", test: "BOB recieved a new grade of A", timestamp: 1234, read: false, ... }, ...]
    
	// then mark all notifications as read
	user.markAllNotificationsRead().then(() => {
	    console.log('notifications marked as read...')
    })

  })

	
})


// listen for any errors thrown while logging in
user.on('error', (err) => {
	console.log('Error while Logging in. Bad credentials.' + err)
})

Disclaimer

This is an unofficial library and is not endorsed or officially recognized by Infinite Campus. The Infinite Campus name is owned by Infinite Campus, Inc and again, has nothing to do with this library. This library uses bits and pieces of both the web and mobile API that drives the Infinite Campus Client. If you are from Infinite Campus and have concerns, please submit an issue. Please don't sue me.

infinite-campus's People

Contributors

icebotyt avatar lathryx avatar qwazwsx avatar sbalbale avatar steve01010 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.