Changes between Version 22 and Version 23 of api_v1

Timestamp:

2012-10-10T17:08:21Z (12 years ago)

Author:

michael

Comment:

events api - retrieving events a user (eg. student) has access to

api_v1

@@ -175 +175 @@
 
 ||GET||/v1/courses/{course_id}/events||get a list of events in course {course_id}||
-|| ||parameter|COURSE_ID||
+|| ||parameter||COURSE_ID||
 || ||status (success)||HTTP/1.1 200 OK||
 || ||output (success)||[{"title":"TITLE0","course_id":"COURSE_ID","event_template_type_id":"TEMPLATE_ID","id":"EVENT_ID0"},{"title":"TITLE1","course_id":"COURSE_ID","event_template_type_id":"TEMPLATE_ID","id":"EVENT_ID1"}]
@@ -188 +188 @@
 || ||output (failure)||none||
 ||GET||/v1/courses/{course_id}/users/{username}/events||get events for a user in a course||
+|| ||parameter||COURSE_ID||
+|| ||parameter||USERNAME||
+|| ||status (success)||HTTP/1.1 200 OK||
+|| ||output (success)||[{"title":"TITLE0","course_id":"COURSE_ID","event_template_type_id":"TEMPLATE_ID","id":"EVENT_ID0"},{"title":"TITLE1","course_id":"COURSE_ID","event_template_type_id":"TEMPLATE_ID","id":"EVENT_ID1"}]||
+|| ||status (failure)||HTTP/1.1 404 Not Found||
+|| ||output (failure)||none||
 ||GET||/v1/users/{username}/events||get events for a user||
-
+|| ||parameter||USERNAME||
+|| ||status (success)||HTTP/1.1 200 OK||
+|| ||output (success)||[{"title":"TITLE0","course_id":"COURSE_ID","event_template_type_id":"TEMPLATE_ID","id":"EVENT_ID0"},{"title":"TITLE1","course_id":"COURSE_ID","event_template_type_id":"TEMPLATE_ID","id":"EVENT_ID1"}]||
+|| ||status (failure)||HTTP/1.1 404 Not Found||
+|| ||output (failure)||none||
 
 * Events are read-only