From 667b87cd927f63fc765f7ab2e451ca2228b3ca04 Mon Sep 17 00:00:00 2001 From: Ajay Ramachandran Date: Fri, 6 Dec 2019 21:47:44 -0500 Subject: [PATCH] Update README.MD --- README.MD | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.MD b/README.MD index bcf91a6..3efd3f8 100644 --- a/README.MD +++ b/README.MD @@ -63,7 +63,7 @@ __________________________________________________________________ videoID: string, startTime: float, endTime: float, - userID: string //This should be a randomly generated UUID + localUserID: string //This should be a randomly generated UUID } ``` @@ -90,7 +90,7 @@ __________________________________________________________________ ``` { UUID: string, //id of the sponsor being voted on - userID: string, + userID: string, //the local user id type: int //0 for downvote, 1 for upvote } ``` @@ -137,7 +137,7 @@ __________________________________________________________________ **Input**: ``` { - userID: string + userID: string //the local user id } ``` @@ -154,12 +154,34 @@ __________________________________________________________________ __________________________________________________________________ +**GET** `/api/getSavedTimeForUser` + +**Input**: +``` +{ + userID: string //the local user id +} +``` + +**Response**: +``` +{ + timeSaved: float //in minutes +} +``` + +**Error codes**: + +404: Not Found + +__________________________________________________________________ + **POST** `/api/setUsername` **Input**: ``` { - userID: string, + userID: string, //local user id normally, public user id if adminUserID is specified userName: string, //optional adminUserID: string //This is if you want to change someone elses username from the admin account @@ -184,7 +206,7 @@ __________________________________________________________________ **Input**: ``` { - userID: string + userID: string //the local user id } ```