Unofficial npm package for accessing the Active911 API. Active911 enables fire and EMS agencies to quickly access real-time incident information.
Merge pull request #6 from benburwell/license-update-2016
Update license with the year 2016
c0ff7db3 — Ben Burwell 3 years ago
Merge pull request #5 from benburwell/release-1.1.1

refs

master
browse log

clone

read-only
https://git.sr.ht/~benburwell/active911
read/write
git@git.sr.ht:~benburwell/active911

You can also use your local clone with git send-email.

Active911 for Node.js

Build Status npm version

by Ben Burwell ben@benburwell.com

Installation

Installation is simple: npm install --save active911.

Basic Usage

var Active911 = require('active911');
var client = new Active911.RefreshClient('YOUR REFRESH TOKEN');

client.getAgency().then(function(agency) {
  console.log(agency.name);
}).catch(function(err) {
  console.log('Problem getting Agency details:', err);
});

API Methods

The following public API methods are available:

  • getAgency()
  • getDevice(device_id)
  • getAlerts({ alert_days: 1, alert_minutes: 30 }), where the object parameter is optional. You should not use both keys; if alert_minutes is provided, it will override alert_days as documented on the wiki.
  • getDeviceAlerts(device_id)
  • getAlert(alert_id)
  • getLocations()
  • getLocation(location_id)
  • getResource(resource_id)

Each method returns a promise for a result, which will resolve as either an object or an array, depending on the cardinality (e.g. getAlerts resolves as an array, while getAlert resolves as an object).

For details on the format of the result, please see the Active911 API wiki.

Contributing

Contributions are encouraged. For a list of open issues, see https://github.com/benburwell/active911/issues.

More Information

More information about the API is available on the Active911 wiki.