Changes between Version 29 and Version 30 of api_v1

Timestamp:

2012-10-25T23:16:48Z (12 years ago)

Author:

michael

Comment:

Match Course/Users to implementation.

api_v1

@@ -94 +94 @@
 
 ||GET||/v1/courses/{course_id}/users||get a list of users associated within the course {course_id}||
+|| ||parameter||COURSE_ID||
+|| ||input|| none
+|| ||status (success)||HTTP/1.1 201 Created||
+|| ||output (success)||[{"id": "1", "username":"username1", "role_id":1}, {"id": "2", "username":"username2", "role_id":1},{"id": "3", "username":"username3", "role_id":2}]||
+|| ||status (failure)||HTTP/1.1 400 Unrecognizable Request||
+|| ||output (failure)|| none ||
 ||POST||/v1/courses{course_id}/users||associate users to the course by {course_id}||
 || ||parameter||COURSE_ID||
-|| ||input||[{"username":"username1", "role_id":1}, {"username":"username2", "role_id":1},{"username":"username3", "role_id":2}], other fields in request will be ignored||
-|| ||status (success)||HTTP/1.1 201 Created||
-|| ||output (success)||[{"username":"username1", "role_id":1}, {"username":"username2", "role_id":1},{"username":"username3", "role_id":2}]||
-|| ||status (failure)||HTTP/1.1 500 Internal Server Error||
-|| ||output (failure)|| none ||
+|| ||input||[{"username":"username1", "role_id":5}, {"username":"username2", "role_id":5},{"username":"username3", "role_id":4}], other fields in request will be ignored||
+|| ||status (success)||HTTP/1.1 200 OK||
+|| ||output (success)||[{"username":"username1", "role_id":5}, {"username":"username2", "role_id":5},{"username":"username3", "role_id":4}]||
+|| ||status (failure)||HTTP/1.1 501 Unsupported role for {username}||
+|| ||note (failure)|| The role_id was unrecognized, recognized role_ids right now are student (5), tutor (4), and instructor (3) ||
+|| ||status (failure)||HTTP/1.1 501 Fail to enrol ${username}||
+|| ||note (failure)|| Tried to save the new enrolments but failed due to a database error. ||
 ||DELETE||/v1/courses/{course_id}/users||remove a user from the course||
 || ||parameter||COURSE_ID||
-|| ||parameter||USER_ID||
-|| ||status (success)||HTTP/1.1 204 No Content||
-|| ||output (success)||none||
-|| ||status (failure)||HTTP/1.1 500 users were not deleted||
-|| ||output (failure)|| none ||
+|| ||input||[{"username":"username1", "role_id":5}, {"username":"username2", "role_id":5},{"username":"username3", "role_id":4}], other fields in request will be ignored||
+|| ||status (success)||HTTP/1.1 200 OK||
+|| ||output (success)||[{"username":"username1", "role_id":5}, {"username":"username2", "role_id":5},{"username":"username3", "role_id":4}]||
+|| ||status (failure)||HTTP/1.1 501 Unsupported role for {username}||
+|| ||note (failure)|| The role_id was unrecognized, recognized role_ids right now are student (5), tutor (4), and instructor (3) ||
+|| ||status (failure)||HTTP/1.1 501 Fail to drop ${username}||
+|| ||note (failure)|| Tried to save the new enrolments but failed due to a database error. ||
 
 === !Courses/Departments ===