Python bindings for active911 API
Project description
Active911 Python Bindings
Install
via pip
pip install active911-python
Manual Installation
Download release and install by:
python setup.py install
Setup / Initialize
Import Package
import active_911
Initialize class
client = active_911.Active911Client(access_token='Enter Access Token Here')
Environment Variable Support
If access_token is not passed you can set ACTIVE911_ACCESS_TOKEN as the environment variable.
Available Methods:
get_agency()
This function will return the authorized agency and is considered the root of the API.
get_device_info(device_id=None)
This function will return detailed device information.
get_device_alerts(device_id=None, alert_days=None, alert_minutes=None)
This function will return agency alerts by device. Number of alerts can be set by alert_days(default:10 Max:30) or alert_minutes, alert_minutes supersedes alert_days if set.
get_alerts(alert_days=None, alert_minutes=None)
Returns agency alerts. Number of alerts can be set by alert_days(default:10 Max:30) or alert_minutes, alert_minutes supersedes alert_days if set.
get_alert_detail(alert_id=None)
Returns alert detail by alert_id.
get_locations(locations_page=None, locations_per_page=None)
Returns all map data locations.
get_location_detail(location_id)
Returns location point detail
get_resource_detail(resource_id)
Returns location point resource detail
Important Notes:
Full OAUTH scope is required for proper functionality.
- read_agency Allows read-only access to this agency's information (Name, Address etc).
- read_alert Allows read-only access to all alerts in the agency.
- read_response Allows read-only access to responses to all alerts in the agency.0
- read_device Allows read-only access to all device information in the agency.
- read_mapdata Allows read-only access to all locations and resources in the agency.
- write_mapdata Allows creation of locations and resources for the agency.
TODOS:
- Add POST request support for mapping locations.
- Support locations_coordinate_window
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for active911_python-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31ff363cf203b82ea86cfd97485c28165bc9180c9e1f1c549b50efe93a7f4fda |
|
MD5 | 8a7f4b129f3dad9aecf66d50b7334226 |
|
BLAKE2b-256 | 516ed612c55b8217dff5e1a25feb480569447b922d53305156514961f78c9813 |
Hashes for active911_python-0.0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13a356f22abd08d3bd114f00d7d09ca146b99522e11efa2f1e1ae414f513b140 |
|
MD5 | 672746389f0518c0ae6d32a62f3015ea |
|
BLAKE2b-256 | 6cd3e54dcb503f909c5974ab288b4b3518c77fffefe3bb567b5ebc8b8baaf9b2 |