> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidoc.dreamclass.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc.dreamclass.io/_mcp/server. # Gradebook GET https://dreamclassapi/v1/grading/gradebook Get a list of the grades of a gradebook for the specified class course ClassCourse: Check GetPeriodClassCourses call GradeMapping: Check GradeMapping call ParentSimpleGradeId: Self referencing to another grade from the list Type: 4 -> Folder 5 -> Point grade 6 -> Grade 7 -> Final Grade (AVG) Colors: Check [https://tailwindcss.com/docs/colors](https://tailwindcss.com/docs/colors) for colors Reference: https://apidoc.dreamclass.io/dream-class-api/grading/gradebook ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /dreamclassapi/v1/grading/gradebook: get: operationId: gradebook summary: Gradebook description: >- Get a list of the grades of a gradebook for the specified class course ClassCourse: Check GetPeriodClassCourses call GradeMapping: Check GradeMapping call ParentSimpleGradeId: Self referencing to another grade from the list Type: 4 -> Folder 5 -> Point grade 6 -> Grade 7 -> Final Grade (AVG) Colors: Check [https://tailwindcss.com/docs/colors](https://tailwindcss.com/docs/colors) for colors tags: - subpackage_grading parameters: - name: classCourseId in: query description: Class course id of the gradebook required: false schema: type: string - name: tenant in: header required: false schema: type: string - name: schoolCode in: header required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Grading_Gradebook_Response_200' servers: - url: https:/ description: https://{server} - url: https://your-webhook-url description: https://your-webhook-url components: schemas: DreamclassapiV1GradingGradebookGetResponsesContentApplicationJsonSchemaGradesItems: type: object properties: id: type: integer name: type: string type: type: integer color: type: string weight: type: integer position: type: integer gradeMappingId: description: Any type parentSimpleGradeId: description: Any type required: - id - name - type - color - weight - position title: >- DreamclassapiV1GradingGradebookGetResponsesContentApplicationJsonSchemaGradesItems Grading_Gradebook_Response_200: type: object properties: id: type: integer grades: type: array items: $ref: >- #/components/schemas/DreamclassapiV1GradingGradebookGetResponsesContentApplicationJsonSchemaGradesItems classCourseId: type: integer required: - id - grades - classCourseId title: Grading_Gradebook_Response_200 ``` ## Examples **Response** ```json { "id": 66, "grades": [ { "id": 420, "name": "Math Tests", "type": 4, "color": "red-600", "weight": 1, "position": 4 }, { "id": 130, "name": "Test1", "type": 6, "color": "cyan-600", "weight": 1, "position": 1, "gradeMappingId": null, "parentSimpleGradeId": null } ], "classCourseId": 70 } ``` **SDK Code** ```python Grading_Gradebook_example import requests url = "https://https/dreamclassapi/v1/grading/gradebook" querystring = {"classCourseId":"{{classCourseId}}"} headers = { "tenant": "{{tenant}}", "schoolCode": "{{schoolCode}}" } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Grading_Gradebook_example const url = 'https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D'; const options = {method: 'GET', headers: {tenant: '{{tenant}}', schoolCode: '{{schoolCode}}'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Grading_Gradebook_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("tenant", "{{tenant}}") req.Header.Add("schoolCode", "{{schoolCode}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Grading_Gradebook_example require 'uri' require 'net/http' url = URI("https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["tenant"] = '{{tenant}}' request["schoolCode"] = '{{schoolCode}}' response = http.request(request) puts response.read_body ``` ```java Grading_Gradebook_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D") .header("tenant", "{{tenant}}") .header("schoolCode", "{{schoolCode}}") .asString(); ``` ```php Grading_Gradebook_example request('GET', 'https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D', [ 'headers' => [ 'schoolCode' => '{{schoolCode}}', 'tenant' => '{{tenant}}', ], ]); echo $response->getBody(); ``` ```csharp Grading_Gradebook_example using RestSharp; var client = new RestClient("https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D"); var request = new RestRequest(Method.GET); request.AddHeader("tenant", "{{tenant}}"); request.AddHeader("schoolCode", "{{schoolCode}}"); IRestResponse response = client.Execute(request); ``` ```swift Grading_Gradebook_example import Foundation let headers = [ "tenant": "{{tenant}}", "schoolCode": "{{schoolCode}}" ] let request = NSMutableURLRequest(url: NSURL(string: "https://https/dreamclassapi/v1/grading/gradebook?classCourseId=%7B%7BclassCourseId%7D%7D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```