summaryrefslogtreecommitdiff
path: root/src/com/p4square/grow/backend/apiinfo.html
diff options
context:
space:
mode:
authorJesse Morgan <jesse@jesterpm.net>2014-03-24 20:01:39 -0700
committerJesse Morgan <jesse@jesterpm.net>2014-03-24 20:01:39 -0700
commit44de44ac6a3879c78b7e31d7e460bb0125275237 (patch)
tree8f3c7cc08e858d93c6ab9965520fc68e2564c0f2 /src/com/p4square/grow/backend/apiinfo.html
parent1494010751e89a6ed748ed90d702d5574ffbdd9b (diff)
Adding index page to backend with API info.
Diffstat (limited to 'src/com/p4square/grow/backend/apiinfo.html')
-rw-r--r--src/com/p4square/grow/backend/apiinfo.html41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/com/p4square/grow/backend/apiinfo.html b/src/com/p4square/grow/backend/apiinfo.html
new file mode 100644
index 0000000..a3637c9
--- /dev/null
+++ b/src/com/p4square/grow/backend/apiinfo.html
@@ -0,0 +1,41 @@
+<html>
+<head>
+<title>API Info</title>
+</head>
+<body>
+<dl>
+<dt>/backend/accounts/{userId}</dt>
+<dd>GET information about <em>userId</em> or PUT new information.</dd>
+
+<dt>/backend/assessment/question/{questionId}</dt>
+<dd>GET information about <em>questionId</em>. Special <em>questionId</em>s: first identifies first question. count returns total number of questions.</dd>
+
+<dt>/backend/accounts/{userId}/assessment</dt>
+<dd>GET the assessment summary for <em>userId</em> or DELETE <em>userId</em>'s assessment.</dd>
+
+<dt>/backend/accounts/{userId}/assessment/answers/{questionId}</dt>
+<dd>GET <em>userId</em>'s answer to <em>questionId</em>, PUT a new answer, or DELETE an answer.</dd>
+
+<dt>/backend/training/{level}</dt>
+<dd>GET all video information for <em>level</em>.</dd>
+
+<dt>/backend/training/{level}/videos/{videoId}</dt>
+<dd>GET video information for <em>videoId</em> in <em>level</em>.</dd>
+
+<dt>/backend/accounts/{userId}/training</dt>
+<dd>GET training record summary for <em>userId</em>.</dd>
+
+<dt>/backend/accounts/{userId}/training/videos/{videoId}</dt>
+<dd>GET training record for <em>userId</em> and <em>videoId</em> or PUT a new record.</dd>
+
+<dt>/backend/banner</dt>
+<dd>GET the info banner or PUT new banner info.</dd>
+
+<dt>/backend/feed/{topic}</dt>
+<dd>Get all threads for forum <em>topic</em>.</dd>
+
+<dt>/backend/feed/{topic}/{thread}</dt>
+<dd>Get all responses to question <em>thread</em> on forum <em>topic</em>.</dd>
+</dl>
+</body>
+</html>