class UserBadgeAssertions(generics.ListAPIView):
"""
**Use Cases**
Request a list of assertions for a user, optionally constrained to a course.
**Example Requests**
GET /api/badges/v1/assertions/user/{username}/
**Response Values**
Body comprised of a list of objects with the following fields:
* badge_class: The badge class the assertion was awarded for. Represented as an object
with the following fields:
* slug: The identifier for the badge class
* issuing_component: The software component responsible for issuing this badge.
* display_name: The display name of the badge.
* course_id: The course key of the course this badge is scoped to, or null if it isn't scoped to a course.
* description: A description of the award and its significance.
* criteria: A description of what is needed to obtain this award.
* image_url: A URL to the icon image used to represent this award.
* image_url: The baked assertion image derived from the badge_class icon-- contains metadata about the award
in its headers.
* assertion_url: The URL to the OpenBadges BadgeAssertion object, for verification by compatible tools
and software.
**Params**
* slug (optional): The identifier for a particular badge class to filter by.
* issuing_component (optional): The issuing component for a particular badge class to filter by
(requires slug to have been specified, or this will be ignored.) If slug is provided and this is not,
assumes the issuing_component should be empty.
* course_id (optional): Returns assertions that were awarded as part of a particular course. If slug is
provided, and this field is not specified, assumes that the target badge has an empty course_id field.
'*' may be used to get all badges with the specified slug, issuing_component combination across all courses.
**Returns**
* 200 on success, with a list of Badge Assertion objects.
* 403 if a user who does not have permission to masquerade as
another user specifies a username other than their own.
* 404 if the specified user does not exist
{
"count": 7,
"previous": null,
"num_pages": 1,
"results": [
{
"badge_class": {
"slug": "special_award",
"issuing_component": "openedx__course",
"display_name": "Very Special Award",
"course_id": "course-v1:edX+DemoX+Demo_Course",
"description": "Awarded for people who did something incredibly special",
"criteria": "Do something incredibly special.",
"image": "http://example.com/media/badge_classes/badges/special_xdpqpBv_9FYOZwN.png"
},
"image_url": "http://badges.example.com/media/issued/cd75b69fc1c979fcc1697c8403da2bdf.png",
"assertion_url": "http://badges.example.com/public/assertions/07020647-e772-44dd-98b7-d13d34335ca6"
},
...
]
}
"""
serializer_class = BadgeAssertionSerializer
authentication_classes = (BearerAuthenticationAllowInactiveUser,
SessionAuthenticationAllowInactiveUser)
permission_classes = (is_field_shared_factory("accomplishments_shared"), )
def filter_queryset(self, queryset):
"""
Return most recent to least recent badge.
"""
return queryset.order_by('-created')
def get_queryset(self):
"""
Get all badges for the username specified.
"""
queryset = BadgeAssertion.objects.filter(
user__username=self.kwargs['username'])
provided_course_id = self.request.query_params.get('course_id')
if provided_course_id == '*':
# We might want to get all the matching course scoped badges to see how many courses
# a user managed to get a specific award on.
course_id = None
elif provided_course_id:
try:
course_id = CourseKey.from_string(provided_course_id)
except InvalidKeyError:
raise InvalidCourseKeyError # lint-amnesty, pylint: disable=raise-missing-from
elif 'slug' not in self.request.query_params:
# Need to get all badges for the user.
course_id = None
else:
# Django won't let us use 'None' for querying a ForeignKey field. We have to use this special
# 'Empty' value to indicate we're looking only for badges without a course key set.
course_id = CourseKeyField.Empty
if course_id is not None:
queryset = queryset.filter(badge_class__course_id=course_id)
if self.request.query_params.get('slug'):
queryset = queryset.filter(
badge_class__slug=self.request.query_params['slug'],
badge_class__issuing_component=self.request.query_params.get(
'issuing_component', ''))
return queryset
class UserBadgeProgress(BadgeProgressViewMixin, GenericAPIView):
"""
** Use cases **
Get list of block event badge configuration for a course for all users who are enrolled.
The currently logged-in user may request all enrolled user's badge progress information if they are allowed.
** Example Requests **
GET /api/badges/v1/progress/courses/{course_id}/user/{username}
** GET Parameters **
A GET request may include the following parameters.
* course_id: (required) A string representation of a Course ID.
* username: (optional) A string representation of a user's username.
** Response Values **
Body comprised of a list of objects with the following fields:
* block_id: The usage key of the course this badge progress is scoped to.
* event_type: The block event associated with how the badge was issued.
* badge_class: The badge class assigned to the course block id. Represented as an object
with the following fields:
* slug: The identifier for the badge class
* issuing_component: The software component responsible for issuing this badge.
* display_name: The display name of the badge.
* course_id: The course key of the course this badge is scoped to, or null if it isn't scoped to a course.
* description: A description of the award and its significance.
* criteria: A description of what is needed to obtain this award.
* image_url: A URL to the icon image used to represent this award.
* assertion: The assertion this badge progress is scoped to.
* image_url: The baked assertion image derived from the badge_class icon-- contains metadata about the award
in its headers.
* assertion_url: The URL to the OpenBadges BadgeAssertion object, for verification by compatible tools
and software.
** Returns **
* 200 on success, with a list of users with badge progress objects.
* 403 if a user who does not have permission to masquerade as
another user specifies a username other than their own.
* 404 if the specified user does not exist
[
{
"course_id": "course-v1:edX+DemoX+Demo_Course",
"block_id": "block-v1:edX+DemoX+Demo_Course+type@chapter+block@dc1e160e5dc348a48a98fa0f4a6e8675",
"block_display_name": "Example Week 1: Getting Started",
"event_type": "chapter_complete",
"badge_class": {
"slug": "special_award",
"issuing_component": "openedx__course",
"display_name": "Very Special Award",
"course_id": "course-v1:edX+DemoX+Demo_Course",
"description": "Awarded for people who did something incredibly special",
"criteria": "Do something incredibly special.",
"image": "http://example.com/media/badge_classes/badges/special_xdpqpBv_9FYOZwN.png"
},
"assertion": {
"issuedOn": "2019-04-20T02:43:06.566955Z",
"expires": "2019-04-30T00:00:00.000000Z",
"revoked": false,
"image_url": "http://badges.example.com/media/issued/cd75b69fc1c979fcc1697c8403da2bdf.png",
"assertion_url": "http://badges.example.com/public/assertions/07020647-e772-44dd-98b7-d13d34335ca6",
"recipient": {
"plaintextIdentity": "*****@*****.**",
},
"issuer": {
"entityType": "Issuer",
"entityId": "npqlh0acRFG5pKKbnb4SRg",
"openBadgeId": "https://api.badgr.io/public/issuers/npqlh0acRFG5pKKbnb4SRg",
"name": "EducateWorkforce",
"image": "https://media.us.badgr.io/uploads/issuers/issuer_logo_77bb4498-838b-45b7-8722-22878fedb5e8.svg",
"email": "*****@*****.**",
"description": "An online learning solution offered with partnering 2-year colleges to help integrate web and digital solutions into their existing courses. The platform was designed by multiple instructional design, usability, and computing experts to include research-based learning features.",
"url": "https://ew-localhost.com",
},
},
},
...
]
"""
authentication_classes = (OAuth2AuthenticationAllowInactiveUser,
SessionAuthenticationAllowInactiveUser)
permission_classes = (is_field_shared_factory("accomplishments_shared"), )
def get(self, request, course_id=None, username=None, *args, **kwargs):
if not username:
username = request.GET.get('username')
if not course_id:
course_id = request.GET.get('course_id')
# Validate course exists with provided course_id
try:
course_key = CourseKey.from_string(course_id)
except InvalidKeyError:
raise self.api_error(
status_code=status.HTTP_404_NOT_FOUND,
developer_message='The provided course key cannot be parsed.',
error_code='invalid_course_key')
if not CourseOverview.get_from_id_if_exists(course_key):
raise self.api_error(
status_code=status.HTTP_404_NOT_FOUND,
developer_message="Requested grade for unknown course {course}"
.format(course=course_id),
error_code='course_does_not_exist')
self.course_section_mapping = _get_course_section_mapping(
request, course_id)
# if username:
# If there is a username passed, get badge progress for a single user
try:
return Response(
self._get_single_user_badge_progress(course_key, username))
except USER_MODEL.DoesNotExist:
raise self.api_error(
status_code=status.HTTP_404_NOT_FOUND,
developer_message=
'The user matching the requested username does not exist.',
error_code='user_does_not_exist')
except CourseEnrollment.DoesNotExist:
raise self.api_error(
status_code=status.HTTP_404_NOT_FOUND,
developer_message=
'The user matching the requested username is not enrolled in this course',
error_code='user_not_enrolled')
