Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
5ee49351
Commit
5ee49351
authored
Aug 19, 2015
by
Eric Fischer
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #9346 from edx/efischer/fix_docs_course_id_team_membership
Updating documentation for team_membership endpoint
parents
276cba90
86f4806e
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
0 deletions
+13
-0
lms/djangoapps/teams/views.py
+13
-0
No files found.
lms/djangoapps/teams/views.py
View file @
5ee49351
...
@@ -752,6 +752,10 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView):
...
@@ -752,6 +752,10 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView):
specified team. The requesting user must be staff or enrolled in
specified team. The requesting user must be staff or enrolled in
the course associated with the team.
the course associated with the team.
* course_id: Returns membership records only for the specified
course. Username must have access to this course, or else team_id
must be in this course.
* page_size: Number of results to return per page.
* page_size: Number of results to return per page.
* page: Page number to retrieve.
* page: Page number to retrieve.
...
@@ -799,6 +803,8 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView):
...
@@ -799,6 +803,8 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView):
If team_id is provided but the team does not exist, a 404 error is
If team_id is provided but the team does not exist, a 404 error is
returned.
returned.
If the specified course_id is invalid, a 404 error is returned.
This endpoint uses 404 error codes to avoid leaking information
This endpoint uses 404 error codes to avoid leaking information
about team or user existence. Specifically, a 404 error will be
about team or user existence. Specifically, a 404 error will be
returned if a logged in user specifies a team_id for a course
returned if a logged in user specifies a team_id for a course
...
@@ -808,6 +814,13 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView):
...
@@ -808,6 +814,13 @@ class MembershipListView(ExpandableFieldViewMixin, GenericAPIView):
memberships will be filtered to memberships in teams associated
memberships will be filtered to memberships in teams associated
with courses that the requesting user is enrolled in.
with courses that the requesting user is enrolled in.
If the course specified by course_id does not contain the team
specified by team_id, a 400 error is returned.
If the user is not enrolled in the course specified by course_id,
and does not have staff access to the course, a 400 error is
returned.
**Response Values for POST**
**Response Values for POST**
Any logged in user enrolled in a course can enroll themselves in a
Any logged in user enrolled in a course can enroll themselves in a
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment