API Documentation

REST API Calls

---

Home page

GET ~~~ ~~~ / ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.Application.index

CARDS

GET ~~~ ~~~ /cards ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.CardController.getCards

Cards sorted by date by default

GET ~~~ ~~~ /card/:id ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.CardController.getCard(id: Int)

GET ~~~ ~~~ /card/:id/comments ~~~ ~~~ ~~~ ~~~ controllers.CardController.getCardComments(id: Int)

PUT ~~~ ~~~ /card ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.CardController.addCard

PUT JSON data: { "recipients" : ["firstname.lastname"], "message" : "kudo message", "senders" : ["firstname.lastname"] }

Email notification embeded

DELETE ~~~ /card/:id ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.CardController.deleteCard(id: Int)

GET ~~~ ~~~ /cards/myCards ~~~ ~~~ ~~~ ~~~ ~~~ controllers.CardController.getMyCards

COMMENTS

GET ~~~ ~~~ /comment/:id ~~~ ~~~ ~~~ ~~~ ~~~ controllers.CommentController.get(id: Int)

PUT ~~~ ~~~ /comment/:card_id ~~~ ~~~ ~~~ ~~~ controllers.CommentController.add(card_id: Int)

USERS

GET ~~~ ~~~ /user/:username ~~~ ~~~ ~~~ ~~~ ~~~ controllers.UserController.getUser(username: String)

GET ~~~ ~~~ /users ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.DirectoryController.getAll

GET ~~~ ~~~ /users/:firstNamePrefix ~~~ ~~~ ~~~ controllers.UserController.getUsers(firstNamePrefix: String, lastNamePrefix = "")

GET ~~~ ~~~ /users/:firstNamePrefix/:lastNamePrefix controllers.UserController.getUsers(firstNamePrefix: String, lastNamePrefix: String)

POST /users/ldapSync ~~~ ~~~ ~~~ ~~~ ~~~ controllers.UserController.ldapSync

DDL

GET ~~~ ~~~ /ddl ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.DDL.initDb

AUTHORIZATION

GET ~~~ ~~~ /directory ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.DirectoryController.getAll

GET ~~~ ~~~ /directory/email/:email ~~~ ~~~ ~~~ controllers.DirectoryController.searchEmail(email: String)

POST /login ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.AuthController.login

{ "username" : "firstname.lastname", "password" : "password" }

POST /logout ~~~ ~~~ ~~~ ~~~ ~~~ ~~~ controllers.AuthController.logout

Map static resources from the /public folder to the /assets URL path

GET ~~~ ~~~ /assets/*file ~~~ ~~~ ~~~ ~~~ ~~~ controllers.Assets.at(path="/public", file)

EMAIL NOTIFICATION

POST /email/sendto/:email controllers.DirectoryController.sendNotification(email: String)