> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.schoolset.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server. # Create a report-card batch POST https://ssuccessv2.com/app/api/v1/report-card/batches Content-Type: application/json Creates a report-card batch, attaches subjects/classes/nodes, stores grading overrides, and synchronizes class and grade teacher assignments in one transaction. Reference: https://docs.schoolset.io/api-reference/school-set-api/report-card-batches/create-report-card-batch ## Authentication - `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend. ## Request ### Body (application/json) This endpoint expects an object. - `name` (string, required) - `language` (string, required) - `show_school_name` (boolean, required) - `show_academic_year` (boolean, required) - `general_comments` (boolean, required) - `subject_comments` (boolean, required) - `attendance` (boolean, required) - `report_card_term_id` (integer, required) - `academic_year_id` (integer, required) - `subject_ids` (list of integer, required) - `parent_signature` (boolean, required) - `school_message` (string, optional, nullable) - `attendance_options` (ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaAttendanceOptions, optional, nullable) - `class_teachers` (list of ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaClassTeachersItems, optional, nullable) - `grade_teachers` (list of ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaGradeTeachersItems, optional, nullable) - `nodes` (list of integer, optional, nullable) - `classes` (list of integer, optional, nullable) - `grading_overrides` (list of ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaGradingOverridesItems, optional, nullable) ## Response ### 200 Batch created and transaction committed - `status` (string, optional) - `message` (string, optional) - `data` (ApiV1ReportCardBatchesPostResponsesContentApplicationJsonSchemaData, optional) ## Errors ### 401 Unauthorized Error Unauthenticated - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 403 Forbidden Error User lacks create-report-cards permission or active-school access - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 422 Unprocessable Entity Error Report-card batch payload failed validation - `message` (string, required) - `errors` (map from string to list of string, required) ## Types ### ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaAttendanceOptions - `track_id` (integer, optional, nullable) - `marking_type_ids` (list of integer, optional) ### ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaClassTeachersItems - `teacher_id` (integer, required) - `class_id` (integer, required) ### ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaGradeTeachersItems - `teacher_id` (integer, required) - `grade_id` (integer, required) ### ApiV1ReportCardBatchesPostRequestBodyContentApplicationJsonSchemaGradingOverridesItems - `grading_scale_type_id` (integer, required) - `subject_id` (integer, required) - `min_value` (double, optional, nullable) - `max_value` (double, optional, nullable) ### ApiV1ReportCardBatchesPostResponsesContentApplicationJsonSchemaData - `id` (integer, required) ## Examples **Request** ```json { "name": "Fall 2026 Report Cards", "language": "en", "show_school_name": true, "show_academic_year": true, "general_comments": true, "subject_comments": true, "attendance": true, "report_card_term_id": 3, "academic_year_id": 2026, "subject_ids": [ 11, 12, 13 ], "parent_signature": true } ``` **Response** ```json { "status": "success", "message": "Created", "data": { "id": 310 } } ``` **SDK Code** ```python import requests url = "https://ssuccessv2.com/app/api/v1/report-card/batches" payload = { "name": "Fall 2026 Report Cards", "language": "en", "show_school_name": True, "show_academic_year": True, "general_comments": True, "subject_comments": True, "attendance": True, "report_card_term_id": 3, "academic_year_id": 2026, "subject_ids": [11, 12, 13], "parent_signature": True } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://ssuccessv2.com/app/api/v1/report-card/batches'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"Fall 2026 Report Cards","language":"en","show_school_name":true,"show_academic_year":true,"general_comments":true,"subject_comments":true,"attendance":true,"report_card_term_id":3,"academic_year_id":2026,"subject_ids":[11,12,13],"parent_signature":true}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://ssuccessv2.com/app/api/v1/report-card/batches" payload := strings.NewReader("{\n \"name\": \"Fall 2026 Report Cards\",\n \"language\": \"en\",\n \"show_school_name\": true,\n \"show_academic_year\": true,\n \"general_comments\": true,\n \"subject_comments\": true,\n \"attendance\": true,\n \"report_card_term_id\": 3,\n \"academic_year_id\": 2026,\n \"subject_ids\": [\n 11,\n 12,\n 13\n ],\n \"parent_signature\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://ssuccessv2.com/app/api/v1/report-card/batches") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Fall 2026 Report Cards\",\n \"language\": \"en\",\n \"show_school_name\": true,\n \"show_academic_year\": true,\n \"general_comments\": true,\n \"subject_comments\": true,\n \"attendance\": true,\n \"report_card_term_id\": 3,\n \"academic_year_id\": 2026,\n \"subject_ids\": [\n 11,\n 12,\n 13\n ],\n \"parent_signature\": true\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://ssuccessv2.com/app/api/v1/report-card/batches") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"Fall 2026 Report Cards\",\n \"language\": \"en\",\n \"show_school_name\": true,\n \"show_academic_year\": true,\n \"general_comments\": true,\n \"subject_comments\": true,\n \"attendance\": true,\n \"report_card_term_id\": 3,\n \"academic_year_id\": 2026,\n \"subject_ids\": [\n 11,\n 12,\n 13\n ],\n \"parent_signature\": true\n}") .asString(); ``` ```php request('POST', 'https://ssuccessv2.com/app/api/v1/report-card/batches', [ 'body' => '{ "name": "Fall 2026 Report Cards", "language": "en", "show_school_name": true, "show_academic_year": true, "general_comments": true, "subject_comments": true, "attendance": true, "report_card_term_id": 3, "academic_year_id": 2026, "subject_ids": [ 11, 12, 13 ], "parent_signature": true }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://ssuccessv2.com/app/api/v1/report-card/batches"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Fall 2026 Report Cards\",\n \"language\": \"en\",\n \"show_school_name\": true,\n \"show_academic_year\": true,\n \"general_comments\": true,\n \"subject_comments\": true,\n \"attendance\": true,\n \"report_card_term_id\": 3,\n \"academic_year_id\": 2026,\n \"subject_ids\": [\n 11,\n 12,\n 13\n ],\n \"parent_signature\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "Fall 2026 Report Cards", "language": "en", "show_school_name": true, "show_academic_year": true, "general_comments": true, "subject_comments": true, "attendance": true, "report_card_term_id": 3, "academic_year_id": 2026, "subject_ids": [11, 12, 13], "parent_signature": true ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/report-card/batches")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```