96h! - eCheck - Mobile App and Admin Portal Swagger API Design Contest

The eCheck-Equipment Verification Solution project involves development of an Android mobile application with a JBoss/Java based backend admin portal which resides in a hosted datacenter.

The purpose of this contest is to design the REST API for the mobile app as well as the admin portal, and here are the detailed tasks:

1. Create swagger document for all the REST API (for both mobile app and admin portal). The api error should be well defined, and for each API, you should provide sufficient details to allow developers to implement it easily. (I’m not asking full implementation details here, just enough description for easy implementation). 
2. Create a mapping file between the admin portal REST APIs and admin portal pages.
3. Create a SQL Workbench ERD file (or a sql script) for the db schema.
4. In your API design you need role-based access control. The ‘admin’ role can access all end-points. The ‘operator’ role can only access mobile end-points. The user will authenticate with username/password, and you can use basic authentication for now.

Provided Documents:

API Calls.docx - the api for the mobile application
eCheck_APIs.xlsx - the api description for both mobile app and admin portal.
eCheck_ERD.PDF - the intial db schema
eCheck-Admin-V.0.01-FINAL.pptx.pdf - the wireframe for the admin portal

Note that the provided API documents are just draft documents, you are free to modify them and make them more RESTful.


Technology Stack:

Java 1.7
Spring 4
REST API
MS SQLSERVER
Hibernate 4
Maven 3

Final Submission Guidelines