REST API

The following documentation is a listing of all routes defined in the application's REST API, and should be kept up to date with changes in the application.

• GET /
  Returns the application HTML shell

• GET /api/user
  Returns the user record of the current user.

• GET /api/users
  Returns a JSON resource containing all users in the system.

• POST /api/create_user
  Creates a new user.

• POST /api/user/<int:user_id>
  Updates a user.

• POST /api/get_token
  Generates a JWT authentication token for a user

• POST /api/is_token_valid
  Validates an authentication token, and returns the user details if valid.

• GET /api/messages
  Returns a JSON resource containing all messages in the application history.

• POST /api/message
  Receives a new incoming message from a Twilio webhook.

• GET /api/tags
  Returns all tags defined in the system.

• POST /api/create_tag
  Creates a new tag which can be assigned to users.

• POST /api/tag/<int:tag_id>
  Updates a tag, given its ID.

• DELETE /api/tag/<int:tag_id>
  Deletes a tag, given its ID.

• POST /api/outgoing
  Posts a new outgoing text message.

• POST /api/broadcast
  Posts a broadcast to all or a subsection of subscribed users.

• GET /api/events
  Retrieves all events in the system.

• PUT /api/event
  Creates a new event.

• POST /api/event/<int:event_id>
  Updates an existing event.

/* vi: set ft=md f-=a */