This repository has been archived by the owner on Jun 30, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 503
RSE 0003
Brad Miller edited this page May 13, 2015
·
7 revisions
Assumptions:
- All of the GET API calls require a user to be authenticated
- All of the information returned by GET is for the authenticated user
- If the user is an instructor they will get information for all students in their course
- All of the POST API calls except for /click require a user to be authenticated
- All information return by GET is relative to the book the user is registered for
| Endpoint | Description |
|---|---|
| hsblog | generic clickstream logging |
| runlog | log and save runs and errors |
| saveprog | saves a program |
| getprog | return a program |
| savegrade | save a grade |
| getuser | return user info |
| getnumonline | count of active users |
| getnumusers | count of all users |
| savehighlight | save information for new highlight |
| deletehighlight | remove |
| gethighlights | get all highlights for a user |
| updatelastPage | save last page viewed |
| getCompletionStatus | get completion status for this subchapter |
| getAllCompletionStatus | get completion status for all chapters/subchapters |
| getlastpage | get last page viewed |
| getCorrectStats | get statistics for an assessment |
| getStudentResults | get my results for an assessment |
| getAggregate results | get aggregate results for an assessment |
| getPollResults | return polling results |
| gettop10Answers | get top 10 most popular answers for a fill in the blank question |
| getSphinxBuildStatus | get current build status from the mule |
| getassignmentgrade | get grade for an assignment |
| getCodeDiffs | get list of diffs between version of code -- not used |
| getCoachingHints | get code coach hints |
| HTTP method | URI | Description |
|---|---|---|
| GET | api/v1/log | return all log data for this user |
| GET | api/v1/code/[divid] | return all code or return latest version of code for divid |
| GET | api/v1/assess/mchoice | return all mulitple choice answers for this user or latest for divid |
| GET | api/v1/assess/fillblank | return all fillin the blank answers for this user or latest for divid |
| GET | api/v1/assess/shortanswer | return all short answers for this user or latest for divid |
| HTTP method | URI | Description |
|---|---|---|
| GET | /api/v1/chapters/[id] | return all chapter ids and metadata for this book or all data for a specified chapter |
| GET | /api/v1/subchapters/[id] | return all subchapter ids and metadata for this book or all data for a specified subchapter |
| GET | /api/v1/assessments/[id] | return all assessments for this user or all data on a specific assessment |
| GET | /api/v1/code/[id] | return all activecode ids for this user or latest version for a specific id |
| GET | /api/v1/click/[id] | return all click log data for this user or all click information about a specific id |
| GET | /api/v1/users |