-
Notifications
You must be signed in to change notification settings - Fork 0
API Documentation
Required permission: key.list
Description: lists all API keys (hashed of course).
Usage: /api/:key/key/list
Required permission: *
Description: generates a master key.
Usage: /api/:key/key/generatemaster
Required permission: none
Description: lists the details of the given key.
Usage: /api/:key/key/test
Required permission: event.list
Description: lists all events.
Usage: /api/:key/event/list
Required permission: event.create
Description: creates a new event.
Usage: /api/:key/event/create?
query parameters (* = required):
- identifier*
- cannot have spaces or be longer than 24 characters
- name*
- description
- status
- can only be 0,1 (disabled,enabled)
Required permission: event.update
Description: updates an existing event
Usage: /api/:key/event/update?
query parameters (* = required):
- identifier*
- cannot have spaces or be longer than 24 characters
- name
- description
- status
- can only be 0,1 (disabled,enabled)
Required permission: event.checkin
Description: checks in a user to an event.
Usage: /api/:key/event/checkin?
query parameters (* = required):
- eventIdentifier*
- an existing event identifier
- userBarcode*
- an existing user barcode
Required permission: event.uncheckin
Description: unchecks in a user to an event.
Usage: /api/:key/event/uncheckin?
query parameters (* = required):
- eventIdentifier*
- an existing event identifier
- userBarcode*
- an existing user barcode
Required permission: event.status
Description: gets the status of an event.
Usage: /api/:key/event/status?
query parameters (* = required):
- eventIdentifier*
- an existing event identifier
Required permission: event.checkedin
Description: gets whether a user is checked into an event
Usage: /api/:key/event/checkedin?
query parameters (* = required):
- eventIdentifier*
- an existing event identifier
- userBarcode*
- an existing user barcode
Required permission: user.list
Description: gets a list of all users.
Usage: /api/:key/user/list
Required permission: user.create
Description: creates a new user.
Usage: /api/:key/user/create?
query parameters (* = required):
- userName*
- name of user
- userEmail*
- a valid email