Skip to content
This repository was archived by the owner on Nov 7, 2019. It is now read-only.

Backend

Kumar Anirudha edited this page Jul 25, 2019 · 4 revisions

AMOS Backend

API /api/

Version: v1

Response Structure

{
    "success": true,        // true or false | boolean
    "statusCode": 200,      // Follow [HTTP Status Code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)
    "data": {},             // Object
    "errors": {},           // Object
    "message": "Message"    // String
}

Postman Collection

User

Base Api: /user

endpoint method description auth header
/ POST Create New User no
/login POST User Login no
/:userId GET Fetch User Data by userId yes
/:userId PUT Update User Data by userId yes

Topic

Base Api: /topic

endpoint method description auth header
/ POST Create New Topic yes
/:topicId PUT Update Topic Data yes
/ GET Fetch all Topics yes
/:topicId GET Fetch Topic Data by topicId yes
/:topicId DELETE Delete Topic Data by topicId yes

Resources

Base Api: /resource

endpoint method description auth header
/ GET Fetch all Resources yes
/:resourceId GET Fetch Resource Data by resourceId yes

AmosGame

Base Api: /game

endpoint method description auth header
/ POST Create New UAG (Unlimited Amos Game) yes
/ GET Fetch all Amos Games yes
/:gameId GET Fetch Amos Game Data by gameId yes
/:gameId/vote POST Vote on Amos Game Data by gameId yes
/:gameId/vote GET Fetch Votes for Amos Game Data by gameId yes

Notification

Base Api: /notification

endpoint method description auth header
/ GET Fetch all notifications yes
/read POST Read an existing notification yes

Clone this wiki locally