Issue with API Request in Open edX: Server Error when Modifying Student Grades

francisewais · July 31, 2023, 7:06am

Hello everyone,

I am a newcomer to openedx, and I encountered the following issue while testing the API of the openedx platform using Postman. When I use the POST method to test the API at “/grades/v1-gradebook/{course_id}/bulk-update”, if I send a request without any content in the body, the server returns a 202 Accepted status. However, when I include data in the body, like the following:

{
    "user_id": 4,
    "usage_key": "block-v1:test+test102+test02+type@sequential+block@016bc6ec071944459c02847b60870d5e"
}

the server returns a 500 Internal Server Error. After checking the server logs, I found that the error is caused by “TypeError: string indices must be integers”. I have also tried sending data in other formats or modifying its content, but none of them seem to work.

Can someone please guide me on the correct format and data to be sent to this API to successfully update a student’s grade for a specific subsection? Any help on how to use this API properly would be greatly appreciated. Thank you!

Anh_Vu_Nguy_n · August 1, 2023, 7:38am

have you tried {LMS_HOST}/api-docs/#/grades/grades_v1_gradebook_bulk-update_create ?

francisewais · August 1, 2023, 10:29am

Yes, I have tried accessing the URL /api-docs/#/grades/grades_v1_gradebook_bulk-update_create. However, the page only prompts me to input ‘courseid’, and when I click ‘execute’, it returns the following content:

HTTP status code: 202
Response body:
Response headers:
- access-control-allow-credentials: true
- access-control-allow-origin: http://local.overhang.io
- allow: POST, OPTIONS
- content-language: zh-cn
- content-length: 2
- content-type: application/json
- date: Tue, 01 Aug 2023 10:11:18 GMT
- server: Caddy
- vary: Accept-Language, Origin, Cookie
- x-frame-options: SAMEORIGIN

This page uses the POST method, but it still doesn’t tell me what kind of data I should send. Do you have any idea about what data I should send or what format the request should follow?

Anh_Vu_Nguy_n · August 2, 2023, 3:05am

The function is here (start from line 734):

github.com

openedx/edx-platform/blob/master/lms/djangoapps/grades/rest_api/v1/gradebook_views.py

"""
Defines an endpoint for gradebook data related to a course.
"""


import logging
from collections import namedtuple
from contextlib import contextmanager
from functools import wraps

from django.contrib.auth import get_user_model
from django.core.cache import cache
from django.db.models import Case, Exists, F, OuterRef, Q, When
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
from opaque_keys import InvalidKeyError
from opaque_keys.edx.keys import CourseKey, UsageKey
from rest_framework import status
from rest_framework.generics import GenericAPIView
from rest_framework.response import Response

This file has been truncated. show original

francisewais · August 2, 2023, 6:11am

I’m grateful for your assistance. It worked!

system · October 31, 2023, 6:11am

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Open edX api issue Development api , tutor , olive	1	200	November 27, 2023
Error in setting grading, assessment, and showing assessment result Site Operations Help	1	375	November 24, 2020
Adding a grades-per-problem API endpoint Collaborative Proposals api	4	985	June 22, 2022
How to fix this error while calling registration api in Open edX tutor Tutor Help how-to , tutor	4	591	November 27, 2023
Create a new student (POST request) Development	3	449	July 30, 2020

Issue with API Request in Open edX: Server Error when Modifying Student Grades

Related topics