edx-grades-api

Grades REST Api for Open edX

WARNING: This Django application makes no sense on its own as it depends on edx-platform.

How to install

Register the application

Add the application to INSTALLED_APPS setting :

INSTALLED_APPS = (
    ...
    'grades_api',
    ...
)

URLs entries

Add URLs entries:

urlpatterns = patterns('',
    ...
    url('^api/grades_api/', include('grades_api.urls', namespace='grades_api'))
    ...
)

How to use

Exposed routes

/api/grades_api/v1/grades/{course_id}

Retrieves the grade for the authenticated user for the course identified by course_id.

Example request:

GET /api/grades_api/v1/grades/org/num/rev
{
  "username": "staff",
  "course_id": "org/num/rev",
  "percentage": 0.67
}

/api/grades_api/v1/grades/{course_id}?username={username}

Retrieves the grade for the user matching the username for the course identified by course_id.

The requesting user has to either be is_staff or username.

License

AGPL.