wiki:api_v1

Version 3 (modified by Pan Luo, 13 years ago) ( diff )

--

Overview

This is the first version of API. The main purpose of this version of API is to provide a way for external applications, e.g., learning management system, to interact with iPeer with tighter integration and better user experience.

Authentication

OAuth 2.0

Resources

Users

GET/v1/usersget a list of users
GET/v1/users/{id}get a user with id
POST/v1/userscreate a user/users
DELETE/v1/users/{id}remove a user with id
PUT/v1/users/{id}update a user with id

Courses

GET/v1/coursesget a list of courses for current logged in user
GET/v1/courses/{id}get a course with id
POST/v1/coursescreate a course
DELETE/v1/courses/{id}remove a course with id
PUT/v1/courses/{id}update a course with id

Groups

GET/v1/courses/{course_id}/groupsget a list of groups in course {course_id}
GET/v1/courses/{course_id}/groups/idget a group in course {course_id}
POST/v1/courses{course_id}/groupscreate a group in course {course_id}
DELETE/v1/courses/{course_id}/groups/{id}remove a group in course {course_id}
PUT/v1/courses/{course_id}/groups/{id}update a group in course {course_id}

Grades

GET/v1/courses/{course_id}/gradesget a list of grades in course {course_id}
GET/v1/courses/{course_id}/grades/idget a grades in course {course_id}
  • Grades are read-only
Note: See TracWiki for help on using the wiki.