https://github.com/joshcap20/scanbandz-v1-api-wrapper
Wrapper for ScanBandz Public API [OUTDATED]
https://github.com/joshcap20/scanbandz-v1-api-wrapper
api python scanbandz wrapper
Last synced: about 1 year ago
JSON representation
Wrapper for ScanBandz Public API [OUTDATED]
- Host: GitHub
- URL: https://github.com/joshcap20/scanbandz-v1-api-wrapper
- Owner: JoshCap20
- Created: 2022-10-02T20:53:15.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T07:02:59.000Z (over 3 years ago)
- Last Synced: 2025-02-02T08:42:18.531Z (over 1 year ago)
- Topics: api, python, scanbandz, wrapper
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ScanBandz v1 API Python Wrapper
This API is no longer available as we migrate to API v2 due to major internal updates.
## Wrapper Public Methods
1. `key_test()` Tests if API-KEY is valid.
2. `get_account()` Get account and billing cycle information.
3. `get_events()` Get aggregate event information for all account related events.
4. `get_event(pk)` Get event details, given event primary key.
5. `add_guest(pk, guest)` Add new guest to event, given event primary key and guest information.
6. `add_guests(pk, guests)` Add new guests to event, given event primary key and guest information.
7. `new_event(event)` Create a new event with an Event object.
8. `update_guest(pk, guests)` Marks guests as attended. Pass a list of unique identifiers.
## Wrapper Attributes
1. `API_KEY` String
Configure API_KEY in settings.py.
[View Full API Documentation](https://scanbandz.com/api/v1/documentation).